diff --git a/CHANGES.md b/CHANGES.md index 402d34ae..d6ba67dc 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,11 @@ # Change Log +## 3.4.5 + +- Soften deferred detail-GET check to warn+skip for collection endpoints without a `_list` action. +- Regenerated actions against v4.6 spec. + + ## 3.4.4 - Add action parameter fail_non_2xx to allow the user to indicate if the diff --git a/actions/delete.circuits.circuit_group_assignments.yaml b/actions/delete.circuits.circuit_group_assignments.yaml index 4c96b9f7..a7de2028 100644 --- a/actions/delete.circuits.circuit_group_assignments.yaml +++ b/actions/delete.circuits.circuit_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a Circuit group assignment object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.circuit_groups.yaml b/actions/delete.circuits.circuit_groups.yaml index 95c4be36..0b7c00ea 100644 --- a/actions/delete.circuits.circuit_groups.yaml +++ b/actions/delete.circuits.circuit_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a circuit group object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.circuit_terminations.yaml b/actions/delete.circuits.circuit_terminations.yaml index 4a3a9fa2..01a617d0 100644 --- a/actions/delete.circuits.circuit_terminations.yaml +++ b/actions/delete.circuits.circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a circuit termination object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.circuit_types.yaml b/actions/delete.circuits.circuit_types.yaml index a7640a5e..44e3cab2 100644 --- a/actions/delete.circuits.circuit_types.yaml +++ b/actions/delete.circuits.circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a circuit type object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.circuits.yaml b/actions/delete.circuits.circuits.yaml index 5e48d84e..42b3de6f 100644 --- a/actions/delete.circuits.circuits.yaml +++ b/actions/delete.circuits.circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a circuit object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.provider_accounts.yaml b/actions/delete.circuits.provider_accounts.yaml index 445071b0..f400938d 100644 --- a/actions/delete.circuits.provider_accounts.yaml +++ b/actions/delete.circuits.provider_accounts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a provider account object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.provider_networks.yaml b/actions/delete.circuits.provider_networks.yaml index 7722130f..5db1dce8 100644 --- a/actions/delete.circuits.provider_networks.yaml +++ b/actions/delete.circuits.provider_networks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a provider network object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.providers.yaml b/actions/delete.circuits.providers.yaml index 3d61da1a..d80523a4 100644 --- a/actions/delete.circuits.providers.yaml +++ b/actions/delete.circuits.providers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a provider object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.virtual_circuit_terminations.yaml b/actions/delete.circuits.virtual_circuit_terminations.yaml index 3c079a5a..30fab072 100644 --- a/actions/delete.circuits.virtual_circuit_terminations.yaml +++ b/actions/delete.circuits.virtual_circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a virtual circuit termination object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.virtual_circuit_types.yaml b/actions/delete.circuits.virtual_circuit_types.yaml index 69a9959a..5cea6267 100644 --- a/actions/delete.circuits.virtual_circuit_types.yaml +++ b/actions/delete.circuits.virtual_circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a virtual circuit type object." enabled: true entry_point: run.py diff --git a/actions/delete.circuits.virtual_circuits.yaml b/actions/delete.circuits.virtual_circuits.yaml index c6edd05a..ad414fe7 100644 --- a/actions/delete.circuits.virtual_circuits.yaml +++ b/actions/delete.circuits.virtual_circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a virtual circuit object." enabled: true entry_point: run.py diff --git a/actions/delete.core.data_sources.yaml b/actions/delete.core.data_sources.yaml index d0daf9aa..21739850 100644 --- a/actions/delete.core.data_sources.yaml +++ b/actions/delete.core.data_sources.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a data source object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.cable_terminations.yaml b/actions/delete.dcim.cable_bundles.yaml similarity index 77% rename from actions/delete.dcim.cable_terminations.yaml rename to actions/delete.dcim.cable_bundles.yaml index eb2e4f92..bb154bbe 100644 --- a/actions/delete.dcim.cable_terminations.yaml +++ b/actions/delete.dcim.cable_bundles.yaml @@ -1,12 +1,12 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Delete a cable termination object." +# NetBox API version: 4.6 +description: "Delete a cable bundle object." enabled: true entry_point: run.py -name: delete.dcim.cable_terminations +name: delete.dcim.cable_bundles parameters: endpoint_uri: - default: "/dcim/cable-terminations/{{ id }}/" + default: "/dcim/cable-bundles/{{ id }}/" immutable: true type: string http_verb: diff --git a/actions/delete.dcim.cables.yaml b/actions/delete.dcim.cables.yaml index f1b7beef..87e97da2 100644 --- a/actions/delete.dcim.cables.yaml +++ b/actions/delete.dcim.cables.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a cable object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.console_port_templates.yaml b/actions/delete.dcim.console_port_templates.yaml index 8a879de7..77651038 100644 --- a/actions/delete.dcim.console_port_templates.yaml +++ b/actions/delete.dcim.console_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a console port template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.console_ports.yaml b/actions/delete.dcim.console_ports.yaml index fd838cc4..95e2ba00 100644 --- a/actions/delete.dcim.console_ports.yaml +++ b/actions/delete.dcim.console_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a console port object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.console_server_port_templates.yaml b/actions/delete.dcim.console_server_port_templates.yaml index 0c12fa9a..fa724547 100644 --- a/actions/delete.dcim.console_server_port_templates.yaml +++ b/actions/delete.dcim.console_server_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a console server port template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.console_server_ports.yaml b/actions/delete.dcim.console_server_ports.yaml index f60ab148..10816b1e 100644 --- a/actions/delete.dcim.console_server_ports.yaml +++ b/actions/delete.dcim.console_server_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a console server port object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.device_bay_templates.yaml b/actions/delete.dcim.device_bay_templates.yaml index 3882e638..80233901 100644 --- a/actions/delete.dcim.device_bay_templates.yaml +++ b/actions/delete.dcim.device_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a device bay template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.device_bays.yaml b/actions/delete.dcim.device_bays.yaml index d0ffb1f2..9f3d1222 100644 --- a/actions/delete.dcim.device_bays.yaml +++ b/actions/delete.dcim.device_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a device bay object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.device_roles.yaml b/actions/delete.dcim.device_roles.yaml index 1132a223..389adad5 100644 --- a/actions/delete.dcim.device_roles.yaml +++ b/actions/delete.dcim.device_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a device role object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.device_types.yaml b/actions/delete.dcim.device_types.yaml index fe125de4..866db4c2 100644 --- a/actions/delete.dcim.device_types.yaml +++ b/actions/delete.dcim.device_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a device type object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.devices.yaml b/actions/delete.dcim.devices.yaml index ad1e681a..817bbc62 100644 --- a/actions/delete.dcim.devices.yaml +++ b/actions/delete.dcim.devices.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a device object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.front_port_templates.yaml b/actions/delete.dcim.front_port_templates.yaml index e742781d..0c301181 100644 --- a/actions/delete.dcim.front_port_templates.yaml +++ b/actions/delete.dcim.front_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a front port template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.front_ports.yaml b/actions/delete.dcim.front_ports.yaml index 7f807aba..02414368 100644 --- a/actions/delete.dcim.front_ports.yaml +++ b/actions/delete.dcim.front_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a front port object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.interface_templates.yaml b/actions/delete.dcim.interface_templates.yaml index bb40655b..f7927123 100644 --- a/actions/delete.dcim.interface_templates.yaml +++ b/actions/delete.dcim.interface_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a interface template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.interfaces.yaml b/actions/delete.dcim.interfaces.yaml index 21479925..d8c06105 100644 --- a/actions/delete.dcim.interfaces.yaml +++ b/actions/delete.dcim.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a interface object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.inventory_item_roles.yaml b/actions/delete.dcim.inventory_item_roles.yaml index d02b2efd..28a8d9a4 100644 --- a/actions/delete.dcim.inventory_item_roles.yaml +++ b/actions/delete.dcim.inventory_item_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a inventory item role object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.inventory_item_templates.yaml b/actions/delete.dcim.inventory_item_templates.yaml index 3beb6537..6b61d217 100644 --- a/actions/delete.dcim.inventory_item_templates.yaml +++ b/actions/delete.dcim.inventory_item_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a inventory item template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.inventory_items.yaml b/actions/delete.dcim.inventory_items.yaml index 9c454ee7..4280c489 100644 --- a/actions/delete.dcim.inventory_items.yaml +++ b/actions/delete.dcim.inventory_items.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a inventory item object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.locations.yaml b/actions/delete.dcim.locations.yaml index d89cd9a9..d50db86a 100644 --- a/actions/delete.dcim.locations.yaml +++ b/actions/delete.dcim.locations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a location object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.mac_addresses.yaml b/actions/delete.dcim.mac_addresses.yaml index bce0635d..13db342b 100644 --- a/actions/delete.dcim.mac_addresses.yaml +++ b/actions/delete.dcim.mac_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a MAC address object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.manufacturers.yaml b/actions/delete.dcim.manufacturers.yaml index 31a7c9de..6d73e30b 100644 --- a/actions/delete.dcim.manufacturers.yaml +++ b/actions/delete.dcim.manufacturers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a manufacturer object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.module_bay_templates.yaml b/actions/delete.dcim.module_bay_templates.yaml index 79849f08..227ec508 100644 --- a/actions/delete.dcim.module_bay_templates.yaml +++ b/actions/delete.dcim.module_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a module bay template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.module_bays.yaml b/actions/delete.dcim.module_bays.yaml index d14cfb80..8cab59a4 100644 --- a/actions/delete.dcim.module_bays.yaml +++ b/actions/delete.dcim.module_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a module bay object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.module_type_profiles.yaml b/actions/delete.dcim.module_type_profiles.yaml index 383a078d..0f0eb548 100644 --- a/actions/delete.dcim.module_type_profiles.yaml +++ b/actions/delete.dcim.module_type_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a module type profile object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.module_types.yaml b/actions/delete.dcim.module_types.yaml index 6eefc206..a6eeda1d 100644 --- a/actions/delete.dcim.module_types.yaml +++ b/actions/delete.dcim.module_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a module type object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.modules.yaml b/actions/delete.dcim.modules.yaml index e5b8487b..0845f08a 100644 --- a/actions/delete.dcim.modules.yaml +++ b/actions/delete.dcim.modules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a module object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.platforms.yaml b/actions/delete.dcim.platforms.yaml index d4353ebb..15727f82 100644 --- a/actions/delete.dcim.platforms.yaml +++ b/actions/delete.dcim.platforms.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a platform object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.power_feeds.yaml b/actions/delete.dcim.power_feeds.yaml index 5f08c062..5f111ccd 100644 --- a/actions/delete.dcim.power_feeds.yaml +++ b/actions/delete.dcim.power_feeds.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a power feed object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.power_outlet_templates.yaml b/actions/delete.dcim.power_outlet_templates.yaml index 5bbb5082..0e509f55 100644 --- a/actions/delete.dcim.power_outlet_templates.yaml +++ b/actions/delete.dcim.power_outlet_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a power outlet template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.power_outlets.yaml b/actions/delete.dcim.power_outlets.yaml index ad017919..5e669893 100644 --- a/actions/delete.dcim.power_outlets.yaml +++ b/actions/delete.dcim.power_outlets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a power outlet object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.power_panels.yaml b/actions/delete.dcim.power_panels.yaml index 99a4f405..340587f0 100644 --- a/actions/delete.dcim.power_panels.yaml +++ b/actions/delete.dcim.power_panels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a power panel object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.power_port_templates.yaml b/actions/delete.dcim.power_port_templates.yaml index d80f79e8..b18f58cd 100644 --- a/actions/delete.dcim.power_port_templates.yaml +++ b/actions/delete.dcim.power_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a power port template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.power_ports.yaml b/actions/delete.dcim.power_ports.yaml index 5eabd801..288109c3 100644 --- a/actions/delete.dcim.power_ports.yaml +++ b/actions/delete.dcim.power_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a power port object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.rack_groups.yaml b/actions/delete.dcim.rack_groups.yaml new file mode 100644 index 00000000..6517d423 --- /dev/null +++ b/actions/delete.dcim.rack_groups.yaml @@ -0,0 +1,27 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Delete a rack group object." +enabled: true +entry_point: run.py +name: delete.dcim.rack_groups +parameters: + endpoint_uri: + default: "/dcim/rack-groups/{{ id }}/" + immutable: true + type: string + http_verb: + default: delete + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + id: + required: true + type: integer + description: "ID of the object to delete." +runner_type: python-script diff --git a/actions/delete.dcim.rack_reservations.yaml b/actions/delete.dcim.rack_reservations.yaml index dabacc33..8e035465 100644 --- a/actions/delete.dcim.rack_reservations.yaml +++ b/actions/delete.dcim.rack_reservations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a rack reservation object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.rack_roles.yaml b/actions/delete.dcim.rack_roles.yaml index 2c31d0f4..cb49b15f 100644 --- a/actions/delete.dcim.rack_roles.yaml +++ b/actions/delete.dcim.rack_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a rack role object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.rack_types.yaml b/actions/delete.dcim.rack_types.yaml index d9ac8d76..34c4662c 100644 --- a/actions/delete.dcim.rack_types.yaml +++ b/actions/delete.dcim.rack_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a rack type object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.racks.yaml b/actions/delete.dcim.racks.yaml index 9f8c7a10..b6d235fe 100644 --- a/actions/delete.dcim.racks.yaml +++ b/actions/delete.dcim.racks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a rack object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.rear_port_templates.yaml b/actions/delete.dcim.rear_port_templates.yaml index 0b35a40f..7a4111b0 100644 --- a/actions/delete.dcim.rear_port_templates.yaml +++ b/actions/delete.dcim.rear_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a rear port template object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.rear_ports.yaml b/actions/delete.dcim.rear_ports.yaml index ab3a3bcd..cd3f821c 100644 --- a/actions/delete.dcim.rear_ports.yaml +++ b/actions/delete.dcim.rear_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a rear port object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.regions.yaml b/actions/delete.dcim.regions.yaml index 4825983b..f5811e7b 100644 --- a/actions/delete.dcim.regions.yaml +++ b/actions/delete.dcim.regions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a region object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.site_groups.yaml b/actions/delete.dcim.site_groups.yaml index 4b3f565d..efb2ef6f 100644 --- a/actions/delete.dcim.site_groups.yaml +++ b/actions/delete.dcim.site_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a site group object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.sites.yaml b/actions/delete.dcim.sites.yaml index 1ff01761..0b2781a1 100644 --- a/actions/delete.dcim.sites.yaml +++ b/actions/delete.dcim.sites.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a site object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.virtual_chassis.yaml b/actions/delete.dcim.virtual_chassis.yaml index a000138b..feb28b83 100644 --- a/actions/delete.dcim.virtual_chassis.yaml +++ b/actions/delete.dcim.virtual_chassis.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a virtual chassis object." enabled: true entry_point: run.py diff --git a/actions/delete.dcim.virtual_device_contexts.yaml b/actions/delete.dcim.virtual_device_contexts.yaml index 3aefab15..d4ca9a03 100644 --- a/actions/delete.dcim.virtual_device_contexts.yaml +++ b/actions/delete.dcim.virtual_device_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a virtual device context object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.bookmarks.yaml b/actions/delete.extras.bookmarks.yaml index e30d637b..c56cc66b 100644 --- a/actions/delete.extras.bookmarks.yaml +++ b/actions/delete.extras.bookmarks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a bookmark object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.config_context_profiles.yaml b/actions/delete.extras.config_context_profiles.yaml new file mode 100644 index 00000000..17bab782 --- /dev/null +++ b/actions/delete.extras.config_context_profiles.yaml @@ -0,0 +1,27 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Delete a config context profile object." +enabled: true +entry_point: run.py +name: delete.extras.config_context_profiles +parameters: + endpoint_uri: + default: "/extras/config-context-profiles/{{ id }}/" + immutable: true + type: string + http_verb: + default: delete + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + id: + required: true + type: integer + description: "ID of the object to delete." +runner_type: python-script diff --git a/actions/delete.extras.config_contexts.yaml b/actions/delete.extras.config_contexts.yaml index 39758ac0..255ca789 100644 --- a/actions/delete.extras.config_contexts.yaml +++ b/actions/delete.extras.config_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a config context object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.config_templates.yaml b/actions/delete.extras.config_templates.yaml index 4e5a6f5e..b77bf08c 100644 --- a/actions/delete.extras.config_templates.yaml +++ b/actions/delete.extras.config_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a config template object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.custom_field_choice_sets.yaml b/actions/delete.extras.custom_field_choice_sets.yaml index b6c62a95..43f5408f 100644 --- a/actions/delete.extras.custom_field_choice_sets.yaml +++ b/actions/delete.extras.custom_field_choice_sets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a custom field choice set object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.custom_fields.yaml b/actions/delete.extras.custom_fields.yaml index 0a74331b..24e693df 100644 --- a/actions/delete.extras.custom_fields.yaml +++ b/actions/delete.extras.custom_fields.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a custom field object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.custom_links.yaml b/actions/delete.extras.custom_links.yaml index 7c9e0610..3f37e0de 100644 --- a/actions/delete.extras.custom_links.yaml +++ b/actions/delete.extras.custom_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a custom link object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.dashboard.yaml b/actions/delete.extras.dashboard.yaml index f6911a35..7a6f604c 100644 --- a/actions/delete.extras.dashboard.yaml +++ b/actions/delete.extras.dashboard.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a list of dashboard objects." enabled: true entry_point: run.py diff --git a/actions/delete.extras.event_rules.yaml b/actions/delete.extras.event_rules.yaml index 95a140fe..06b00628 100644 --- a/actions/delete.extras.event_rules.yaml +++ b/actions/delete.extras.event_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a event rule object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.export_templates.yaml b/actions/delete.extras.export_templates.yaml index 0765b38c..502e4b46 100644 --- a/actions/delete.extras.export_templates.yaml +++ b/actions/delete.extras.export_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a export template object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.image_attachments.yaml b/actions/delete.extras.image_attachments.yaml index 91101551..f9a7861c 100644 --- a/actions/delete.extras.image_attachments.yaml +++ b/actions/delete.extras.image_attachments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a image attachment object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.journal_entries.yaml b/actions/delete.extras.journal_entries.yaml index 855f25a9..3dda7114 100644 --- a/actions/delete.extras.journal_entries.yaml +++ b/actions/delete.extras.journal_entries.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a journal entry object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.notification_groups.yaml b/actions/delete.extras.notification_groups.yaml index e5f71405..1ca352fc 100644 --- a/actions/delete.extras.notification_groups.yaml +++ b/actions/delete.extras.notification_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a notification group object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.notifications.yaml b/actions/delete.extras.notifications.yaml index 62148f70..16a9fe73 100644 --- a/actions/delete.extras.notifications.yaml +++ b/actions/delete.extras.notifications.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a notification object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.saved_filters.yaml b/actions/delete.extras.saved_filters.yaml index 4eeabcba..91ec1049 100644 --- a/actions/delete.extras.saved_filters.yaml +++ b/actions/delete.extras.saved_filters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a saved filter object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.scripts.yaml b/actions/delete.extras.scripts.yaml index a3ec7744..11716fb9 100644 --- a/actions/delete.extras.scripts.yaml +++ b/actions/delete.extras.scripts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a script object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.subscriptions.yaml b/actions/delete.extras.subscriptions.yaml index a6547085..9e987180 100644 --- a/actions/delete.extras.subscriptions.yaml +++ b/actions/delete.extras.subscriptions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a subscription object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.table_configs.yaml b/actions/delete.extras.table_configs.yaml index 41d7d90a..fd350461 100644 --- a/actions/delete.extras.table_configs.yaml +++ b/actions/delete.extras.table_configs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a table config object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.tags.yaml b/actions/delete.extras.tags.yaml index 22255a10..dcd72750 100644 --- a/actions/delete.extras.tags.yaml +++ b/actions/delete.extras.tags.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a tag object." enabled: true entry_point: run.py diff --git a/actions/delete.extras.webhooks.yaml b/actions/delete.extras.webhooks.yaml index 30760acf..fd32023f 100644 --- a/actions/delete.extras.webhooks.yaml +++ b/actions/delete.extras.webhooks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a webhook object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.aggregates.yaml b/actions/delete.ipam.aggregates.yaml index 7303df91..1c4d36d6 100644 --- a/actions/delete.ipam.aggregates.yaml +++ b/actions/delete.ipam.aggregates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a aggregate object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.asn_ranges.yaml b/actions/delete.ipam.asn_ranges.yaml index 630fc5ec..c3884b78 100644 --- a/actions/delete.ipam.asn_ranges.yaml +++ b/actions/delete.ipam.asn_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a ASN range object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.asns.yaml b/actions/delete.ipam.asns.yaml index 6e6a5317..68d7791c 100644 --- a/actions/delete.ipam.asns.yaml +++ b/actions/delete.ipam.asns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a ASN object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.fhrp_group_assignments.yaml b/actions/delete.ipam.fhrp_group_assignments.yaml index 8a80b82e..5aff5d7d 100644 --- a/actions/delete.ipam.fhrp_group_assignments.yaml +++ b/actions/delete.ipam.fhrp_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a FHRP group assignment object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.fhrp_groups.yaml b/actions/delete.ipam.fhrp_groups.yaml index b1532519..10851d43 100644 --- a/actions/delete.ipam.fhrp_groups.yaml +++ b/actions/delete.ipam.fhrp_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a FHRP group object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.ip_addresses.yaml b/actions/delete.ipam.ip_addresses.yaml index 17ef8155..c2ab800d 100644 --- a/actions/delete.ipam.ip_addresses.yaml +++ b/actions/delete.ipam.ip_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a IP address object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.ip_ranges.yaml b/actions/delete.ipam.ip_ranges.yaml index f38c81dc..1a469de8 100644 --- a/actions/delete.ipam.ip_ranges.yaml +++ b/actions/delete.ipam.ip_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a IP range object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.prefixes.yaml b/actions/delete.ipam.prefixes.yaml index 34d3e2ad..12adf3fe 100644 --- a/actions/delete.ipam.prefixes.yaml +++ b/actions/delete.ipam.prefixes.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a prefix object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.rirs.yaml b/actions/delete.ipam.rirs.yaml index 3242ab98..d15acf7d 100644 --- a/actions/delete.ipam.rirs.yaml +++ b/actions/delete.ipam.rirs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a RIR object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.roles.yaml b/actions/delete.ipam.roles.yaml index d6382d62..70f1f026 100644 --- a/actions/delete.ipam.roles.yaml +++ b/actions/delete.ipam.roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a role object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.route_targets.yaml b/actions/delete.ipam.route_targets.yaml index cef24168..928835ce 100644 --- a/actions/delete.ipam.route_targets.yaml +++ b/actions/delete.ipam.route_targets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a route target object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.service_templates.yaml b/actions/delete.ipam.service_templates.yaml index 8978e5b2..ba92c4f2 100644 --- a/actions/delete.ipam.service_templates.yaml +++ b/actions/delete.ipam.service_templates.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Delete a service template object." +# NetBox API version: 4.6 +description: "Delete a application service template object." enabled: true entry_point: run.py name: delete.ipam.service_templates diff --git a/actions/delete.ipam.services.yaml b/actions/delete.ipam.services.yaml index 1d73a1cf..727157be 100644 --- a/actions/delete.ipam.services.yaml +++ b/actions/delete.ipam.services.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Delete a service object." +# NetBox API version: 4.6 +description: "Delete a application service object." enabled: true entry_point: run.py name: delete.ipam.services diff --git a/actions/delete.ipam.vlan_groups.yaml b/actions/delete.ipam.vlan_groups.yaml index 46864dbc..ace04e9b 100644 --- a/actions/delete.ipam.vlan_groups.yaml +++ b/actions/delete.ipam.vlan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a VLAN group object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.vlan_translation_policies.yaml b/actions/delete.ipam.vlan_translation_policies.yaml index 20126404..153ea797 100644 --- a/actions/delete.ipam.vlan_translation_policies.yaml +++ b/actions/delete.ipam.vlan_translation_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a VLAN translation policy object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.vlan_translation_rules.yaml b/actions/delete.ipam.vlan_translation_rules.yaml index 7d042906..c43f36ae 100644 --- a/actions/delete.ipam.vlan_translation_rules.yaml +++ b/actions/delete.ipam.vlan_translation_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a VLAN translation rule object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.vlans.yaml b/actions/delete.ipam.vlans.yaml index 50a654ed..c091e214 100644 --- a/actions/delete.ipam.vlans.yaml +++ b/actions/delete.ipam.vlans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a VLAN object." enabled: true entry_point: run.py diff --git a/actions/delete.ipam.vrfs.yaml b/actions/delete.ipam.vrfs.yaml index efe7ed01..6f8fb407 100644 --- a/actions/delete.ipam.vrfs.yaml +++ b/actions/delete.ipam.vrfs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a VRF object." enabled: true entry_point: run.py diff --git a/actions/delete.tenancy.contact_assignments.yaml b/actions/delete.tenancy.contact_assignments.yaml index d1be8ee2..c54fae62 100644 --- a/actions/delete.tenancy.contact_assignments.yaml +++ b/actions/delete.tenancy.contact_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a contact assignment object." enabled: true entry_point: run.py diff --git a/actions/delete.tenancy.contact_groups.yaml b/actions/delete.tenancy.contact_groups.yaml index 02cc615a..82111479 100644 --- a/actions/delete.tenancy.contact_groups.yaml +++ b/actions/delete.tenancy.contact_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a contact group object." enabled: true entry_point: run.py diff --git a/actions/delete.tenancy.contact_roles.yaml b/actions/delete.tenancy.contact_roles.yaml index 802517da..8a82e7bc 100644 --- a/actions/delete.tenancy.contact_roles.yaml +++ b/actions/delete.tenancy.contact_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a contact role object." enabled: true entry_point: run.py diff --git a/actions/delete.tenancy.contacts.yaml b/actions/delete.tenancy.contacts.yaml index 3d4550ca..2d5f818a 100644 --- a/actions/delete.tenancy.contacts.yaml +++ b/actions/delete.tenancy.contacts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a contact object." enabled: true entry_point: run.py diff --git a/actions/delete.tenancy.tenant_groups.yaml b/actions/delete.tenancy.tenant_groups.yaml index 01606b14..f6dc20a6 100644 --- a/actions/delete.tenancy.tenant_groups.yaml +++ b/actions/delete.tenancy.tenant_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a tenant group object." enabled: true entry_point: run.py diff --git a/actions/delete.tenancy.tenants.yaml b/actions/delete.tenancy.tenants.yaml index e142c7c6..73e22fc5 100644 --- a/actions/delete.tenancy.tenants.yaml +++ b/actions/delete.tenancy.tenants.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a tenant object." enabled: true entry_point: run.py diff --git a/actions/delete.users.groups.yaml b/actions/delete.users.groups.yaml index 85e16317..6331f966 100644 --- a/actions/delete.users.groups.yaml +++ b/actions/delete.users.groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a group object." enabled: true entry_point: run.py diff --git a/actions/delete.users.owner_groups.yaml b/actions/delete.users.owner_groups.yaml new file mode 100644 index 00000000..c3d2e20a --- /dev/null +++ b/actions/delete.users.owner_groups.yaml @@ -0,0 +1,27 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Delete a owner group object." +enabled: true +entry_point: run.py +name: delete.users.owner_groups +parameters: + endpoint_uri: + default: "/users/owner-groups/{{ id }}/" + immutable: true + type: string + http_verb: + default: delete + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + id: + required: true + type: integer + description: "ID of the object to delete." +runner_type: python-script diff --git a/actions/delete.users.owners.yaml b/actions/delete.users.owners.yaml new file mode 100644 index 00000000..1d5ec518 --- /dev/null +++ b/actions/delete.users.owners.yaml @@ -0,0 +1,27 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Delete a owner object." +enabled: true +entry_point: run.py +name: delete.users.owners +parameters: + endpoint_uri: + default: "/users/owners/{{ id }}/" + immutable: true + type: string + http_verb: + default: delete + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + id: + required: true + type: integer + description: "ID of the object to delete." +runner_type: python-script diff --git a/actions/delete.users.permissions.yaml b/actions/delete.users.permissions.yaml index 571d4846..d5198386 100644 --- a/actions/delete.users.permissions.yaml +++ b/actions/delete.users.permissions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a permission object." enabled: true entry_point: run.py diff --git a/actions/delete.users.tokens.yaml b/actions/delete.users.tokens.yaml index fa723416..46c1a9b7 100644 --- a/actions/delete.users.tokens.yaml +++ b/actions/delete.users.tokens.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a token object." enabled: true entry_point: run.py diff --git a/actions/delete.users.users.yaml b/actions/delete.users.users.yaml index 7ad5d81a..f764ad72 100644 --- a/actions/delete.users.users.yaml +++ b/actions/delete.users.users.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a user object." enabled: true entry_point: run.py diff --git a/actions/delete.virtualization.cluster_groups.yaml b/actions/delete.virtualization.cluster_groups.yaml index 76ece7bd..e8765138 100644 --- a/actions/delete.virtualization.cluster_groups.yaml +++ b/actions/delete.virtualization.cluster_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a cluster group object." enabled: true entry_point: run.py diff --git a/actions/delete.virtualization.cluster_types.yaml b/actions/delete.virtualization.cluster_types.yaml index ce243bfb..7f5c70a3 100644 --- a/actions/delete.virtualization.cluster_types.yaml +++ b/actions/delete.virtualization.cluster_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a cluster type object." enabled: true entry_point: run.py diff --git a/actions/delete.virtualization.clusters.yaml b/actions/delete.virtualization.clusters.yaml index c9723d44..f4d10784 100644 --- a/actions/delete.virtualization.clusters.yaml +++ b/actions/delete.virtualization.clusters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a cluster object." enabled: true entry_point: run.py diff --git a/actions/delete.virtualization.interfaces.yaml b/actions/delete.virtualization.interfaces.yaml index 76589a30..d1a96bbb 100644 --- a/actions/delete.virtualization.interfaces.yaml +++ b/actions/delete.virtualization.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a interface object." enabled: true entry_point: run.py diff --git a/actions/delete.virtualization.virtual_disks.yaml b/actions/delete.virtualization.virtual_disks.yaml index 56b5d2eb..a451bc37 100644 --- a/actions/delete.virtualization.virtual_disks.yaml +++ b/actions/delete.virtualization.virtual_disks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a virtual disk object." enabled: true entry_point: run.py diff --git a/actions/delete.virtualization.virtual_machine_types.yaml b/actions/delete.virtualization.virtual_machine_types.yaml new file mode 100644 index 00000000..d9802cc3 --- /dev/null +++ b/actions/delete.virtualization.virtual_machine_types.yaml @@ -0,0 +1,27 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Delete a virtual machine type object." +enabled: true +entry_point: run.py +name: delete.virtualization.virtual_machine_types +parameters: + endpoint_uri: + default: "/virtualization/virtual-machine-types/{{ id }}/" + immutable: true + type: string + http_verb: + default: delete + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + id: + required: true + type: integer + description: "ID of the object to delete." +runner_type: python-script diff --git a/actions/delete.virtualization.virtual_machines.yaml b/actions/delete.virtualization.virtual_machines.yaml index 101052fe..a1a1d075 100644 --- a/actions/delete.virtualization.virtual_machines.yaml +++ b/actions/delete.virtualization.virtual_machines.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a virtual machine object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.ike_policies.yaml b/actions/delete.vpn.ike_policies.yaml index 834a2c09..39d60e42 100644 --- a/actions/delete.vpn.ike_policies.yaml +++ b/actions/delete.vpn.ike_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a IKE policy object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.ike_proposals.yaml b/actions/delete.vpn.ike_proposals.yaml index 1f7f25b2..613cc712 100644 --- a/actions/delete.vpn.ike_proposals.yaml +++ b/actions/delete.vpn.ike_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a IKE proposal object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.ipsec_policies.yaml b/actions/delete.vpn.ipsec_policies.yaml index 0abf6b81..007bd37a 100644 --- a/actions/delete.vpn.ipsec_policies.yaml +++ b/actions/delete.vpn.ipsec_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a IPSec policy object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.ipsec_profiles.yaml b/actions/delete.vpn.ipsec_profiles.yaml index 5e7f8c35..20068c21 100644 --- a/actions/delete.vpn.ipsec_profiles.yaml +++ b/actions/delete.vpn.ipsec_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a IPSec profile object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.ipsec_proposals.yaml b/actions/delete.vpn.ipsec_proposals.yaml index 717eeac9..ff191f92 100644 --- a/actions/delete.vpn.ipsec_proposals.yaml +++ b/actions/delete.vpn.ipsec_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a IPSec proposal object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.l2vpn_terminations.yaml b/actions/delete.vpn.l2vpn_terminations.yaml index 4ae5761d..de120364 100644 --- a/actions/delete.vpn.l2vpn_terminations.yaml +++ b/actions/delete.vpn.l2vpn_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a L2VPN termination object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.l2vpns.yaml b/actions/delete.vpn.l2vpns.yaml index 5988e5ce..b8433b0d 100644 --- a/actions/delete.vpn.l2vpns.yaml +++ b/actions/delete.vpn.l2vpns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a L2VPN object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.tunnel_groups.yaml b/actions/delete.vpn.tunnel_groups.yaml index bf47431f..51795c15 100644 --- a/actions/delete.vpn.tunnel_groups.yaml +++ b/actions/delete.vpn.tunnel_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a tunnel group object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.tunnel_terminations.yaml b/actions/delete.vpn.tunnel_terminations.yaml index 184e5977..b2a3e361 100644 --- a/actions/delete.vpn.tunnel_terminations.yaml +++ b/actions/delete.vpn.tunnel_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a tunnel termination object." enabled: true entry_point: run.py diff --git a/actions/delete.vpn.tunnels.yaml b/actions/delete.vpn.tunnels.yaml index 32851ff4..ecaf4fea 100644 --- a/actions/delete.vpn.tunnels.yaml +++ b/actions/delete.vpn.tunnels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a tunnel object." enabled: true entry_point: run.py diff --git a/actions/delete.wireless.wireless_lan_groups.yaml b/actions/delete.wireless.wireless_lan_groups.yaml index fbeaa968..a48a9744 100644 --- a/actions/delete.wireless.wireless_lan_groups.yaml +++ b/actions/delete.wireless.wireless_lan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a wireless LAN group object." enabled: true entry_point: run.py diff --git a/actions/delete.wireless.wireless_lans.yaml b/actions/delete.wireless.wireless_lans.yaml index 9c870715..23a95520 100644 --- a/actions/delete.wireless.wireless_lans.yaml +++ b/actions/delete.wireless.wireless_lans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a wireless LAN object." enabled: true entry_point: run.py diff --git a/actions/delete.wireless.wireless_links.yaml b/actions/delete.wireless.wireless_links.yaml index 5850b628..324e9708 100644 --- a/actions/delete.wireless.wireless_links.yaml +++ b/actions/delete.wireless.wireless_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Delete a wireless link object." enabled: true entry_point: run.py diff --git a/actions/get.circuits.circuit_group_assignments.yaml b/actions/get.circuits.circuit_group_assignments.yaml index 6a804c22..4d6b8118 100644 --- a/actions/get.circuits.circuit_group_assignments.yaml +++ b/actions/get.circuits.circuit_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of Circuit group assignment objects." enabled: true entry_point: run.py @@ -22,39 +22,39 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. circuit: required: false - type: array + type: string description: "Circuit" circuit_id: required: false - type: array + type: integer description: "Circuit_id" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -62,23 +62,23 @@ parameters: description: "Created_by_request" group: required: false - type: array + type: string description: "Circuit group (slug)" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: integer description: "Circuit group (ID)" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -86,51 +86,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -138,7 +138,7 @@ parameters: description: "Number of results to return per page." member_id: required: false - type: array + type: integer description: "Member_id" member_id__empty: required: false @@ -146,23 +146,23 @@ parameters: description: "Member_id is empty/null (boolean)" member_id__gt: required: false - type: array + type: integer description: "Member_id greater than" member_id__gte: required: false - type: array + type: integer description: "Member_id greater than or equal to" member_id__lt: required: false - type: array + type: integer description: "Member_id less than" member_id__lte: required: false - type: array + type: integer description: "Member_id less than or equal to" member_id__n: required: false - type: array + type: integer description: "Member_id not equal to" member_type: required: false @@ -191,33 +191,85 @@ parameters: * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive" + priority__empty: + required: false + type: boolean + description: "Priority is empty/null (boolean)" + priority__ic: + required: false + type: string + description: "Priority contains (case-insensitive)" + priority__ie: + required: false + type: string + description: "Priority exact match (case-insensitive)" + priority__iew: + required: false + type: string + description: "Priority ends with (case-insensitive)" + priority__iregex: + required: false + type: string + description: "Priority" + priority__isw: + required: false + type: string + description: "Priority starts with (case-sensitive)" + priority__n: + required: false + type: string + description: "Priority not equal to" + priority__nic: + required: false + type: string + description: "Priority does not contain (case-insensitive)" + priority__nie: + required: false + type: string + description: "Priority inverse exact match (case-insensitive)" + priority__niew: + required: false + type: string + description: "Priority does not end with (case-insensitive)" + priority__nisw: + required: false + type: string + description: "Priority does not start with (case-sensitive)" + priority__regex: + required: false + type: string + description: "Priority" provider: required: false - type: array + type: string description: "Provider" provider_id: required: false - type: array + type: integer description: "Provider_id" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -225,11 +277,11 @@ parameters: description: "Updated_by_request" virtual_circuit: required: false - type: array + type: string description: "Virtual_circuit" virtual_circuit_id: required: false - type: array + type: integer description: "Virtual_circuit_id" save_in_key_store: type: boolean diff --git a/actions/get.circuits.circuit_groups.yaml b/actions/get.circuits.circuit_groups.yaml index 2b6b40ab..9841ecbd 100644 --- a/actions/get.circuits.circuit_groups.yaml +++ b/actions/get.circuits.circuit_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of circuit group objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,13 +228,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -226,87 +274,99 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.circuits.circuit_terminations.paths.yaml b/actions/get.circuits.circuit_terminations.paths.yaml index 8aad1b2a..9af57a04 100644 --- a/actions/get.circuits.circuit_terminations.paths.yaml +++ b/actions/get.circuits.circuit_terminations.paths.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Return all CablePaths which traverse a given pass-through port." enabled: true entry_point: run.py diff --git a/actions/get.circuits.circuit_terminations.yaml b/actions/get.circuits.circuit_terminations.yaml index a8bfd8d9..bb8dd457 100644 --- a/actions/get.circuits.circuit_terminations.yaml +++ b/actions/get.circuits.circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of circuit termination objects." enabled: true entry_point: run.py @@ -20,18 +20,94 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -39,39 +115,39 @@ parameters: description: "Cabled" circuit_id: required: false - type: array + type: integer description: "Circuit" circuit_id__n: required: false - type: array + type: integer description: "Circuit_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -79,7 +155,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -87,43 +163,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -131,51 +215,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -183,19 +267,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" mark_connected: required: false @@ -219,7 +303,7 @@ parameters: description: "Which field to use when ordering the results." port_speed: required: false - type: array + type: integer description: "Port_speed" port_speed__empty: required: false @@ -227,27 +311,27 @@ parameters: description: "Port_speed is empty/null (boolean)" port_speed__gt: required: false - type: array + type: integer description: "Port_speed greater than" port_speed__gte: required: false - type: array + type: integer description: "Port_speed greater than or equal to" port_speed__lt: required: false - type: array + type: integer description: "Port_speed less than" port_speed__lte: required: false - type: array + type: integer description: "Port_speed less than or equal to" port_speed__n: required: false - type: array + type: integer description: "Port_speed not equal to" pp_info: required: false - type: array + type: string description: "Pp_info" pp_info__empty: required: false @@ -255,63 +339,71 @@ parameters: description: "Pp_info is empty/null (boolean)" pp_info__ic: required: false - type: array + type: string description: "Pp_info contains (case-insensitive)" pp_info__ie: required: false - type: array + type: string description: "Pp_info exact match (case-insensitive)" pp_info__iew: required: false - type: array + type: string description: "Pp_info ends with (case-insensitive)" + pp_info__iregex: + required: false + type: string + description: "Pp_info" pp_info__isw: required: false - type: array + type: string description: "Pp_info starts with (case-sensitive)" pp_info__n: required: false - type: array + type: string description: "Pp_info not equal to" pp_info__nic: required: false - type: array + type: string description: "Pp_info does not contain (case-insensitive)" pp_info__nie: required: false - type: array + type: string description: "Pp_info inverse exact match (case-insensitive)" pp_info__niew: required: false - type: array + type: string description: "Pp_info does not end with (case-insensitive)" pp_info__nisw: required: false - type: array + type: string description: "Pp_info does not start with (case-sensitive)" + pp_info__regex: + required: false + type: string + description: "Pp_info" provider: required: false - type: array + type: string description: "Provider (slug)" provider__n: required: false - type: array + type: string description: "Provider not equal to" provider_id: required: false - type: array + type: integer description: "Provider (ID)" provider_id__n: required: false - type: array + type: integer description: "Provider_id not equal to" provider_network_id: required: false - type: array + type: integer description: "ProviderNetwork (ID)" provider_network_id__n: required: false - type: array + type: integer description: "Provider_network_id not equal to" q: required: false @@ -319,76 +411,128 @@ parameters: description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" term_side: required: false type: string description: "* `A` - A * `Z` - Z" + term_side__empty: + required: false + type: boolean + description: "Term_side is empty/null (boolean)" + term_side__ic: + required: false + type: string + description: "Term_side contains (case-insensitive)" + term_side__ie: + required: false + type: string + description: "Term_side exact match (case-insensitive)" + term_side__iew: + required: false + type: string + description: "Term_side ends with (case-insensitive)" + term_side__iregex: + required: false + type: string + description: "Term_side" + term_side__isw: + required: false + type: string + description: "Term_side starts with (case-sensitive)" + term_side__n: + required: false + type: string + description: "Term_side not equal to" + term_side__nic: + required: false + type: string + description: "Term_side does not contain (case-insensitive)" + term_side__nie: + required: false + type: string + description: "Term_side inverse exact match (case-insensitive)" + term_side__niew: + required: false + type: string + description: "Term_side does not end with (case-insensitive)" + term_side__nisw: + required: false + type: string + description: "Term_side does not start with (case-sensitive)" + term_side__regex: + required: false + type: string + description: "Term_side" termination_id: required: false - type: array + type: integer description: "Termination_id" termination_id__empty: required: false @@ -396,23 +540,23 @@ parameters: description: "Termination_id is empty/null (boolean)" termination_id__gt: required: false - type: array + type: integer description: "Termination_id greater than" termination_id__gte: required: false - type: array + type: integer description: "Termination_id greater than or equal to" termination_id__lt: required: false - type: array + type: integer description: "Termination_id less than" termination_id__lte: required: false - type: array + type: integer description: "Termination_id less than or equal to" termination_id__n: required: false - type: array + type: integer description: "Termination_id not equal to" termination_type: required: false @@ -428,7 +572,7 @@ parameters: description: "Updated_by_request" upstream_speed: required: false - type: array + type: integer description: "Upstream_speed" upstream_speed__empty: required: false @@ -436,27 +580,27 @@ parameters: description: "Upstream_speed is empty/null (boolean)" upstream_speed__gt: required: false - type: array + type: integer description: "Upstream_speed greater than" upstream_speed__gte: required: false - type: array + type: integer description: "Upstream_speed greater than or equal to" upstream_speed__lt: required: false - type: array + type: integer description: "Upstream_speed less than" upstream_speed__lte: required: false - type: array + type: integer description: "Upstream_speed less than or equal to" upstream_speed__n: required: false - type: array + type: integer description: "Upstream_speed not equal to" xconnect_id: required: false - type: array + type: string description: "Xconnect_id" xconnect_id__empty: required: false @@ -464,40 +608,48 @@ parameters: description: "Xconnect_id is empty/null (boolean)" xconnect_id__ic: required: false - type: array + type: string description: "Xconnect_id contains (case-insensitive)" xconnect_id__ie: required: false - type: array + type: string description: "Xconnect_id exact match (case-insensitive)" xconnect_id__iew: required: false - type: array + type: string description: "Xconnect_id ends with (case-insensitive)" + xconnect_id__iregex: + required: false + type: string + description: "Xconnect_id" xconnect_id__isw: required: false - type: array + type: string description: "Xconnect_id starts with (case-sensitive)" xconnect_id__n: required: false - type: array + type: string description: "Xconnect_id not equal to" xconnect_id__nic: required: false - type: array + type: string description: "Xconnect_id does not contain (case-insensitive)" xconnect_id__nie: required: false - type: array + type: string description: "Xconnect_id inverse exact match (case-insensitive)" xconnect_id__niew: required: false - type: array + type: string description: "Xconnect_id does not end with (case-insensitive)" xconnect_id__nisw: required: false - type: array + type: string description: "Xconnect_id does not start with (case-sensitive)" + xconnect_id__regex: + required: false + type: string + description: "Xconnect_id" save_in_key_store: type: boolean default: false diff --git a/actions/get.circuits.circuit_types.yaml b/actions/get.circuits.circuit_types.yaml index 02b24151..32d7b16f 100644 --- a/actions/get.circuits.circuit_types.yaml +++ b/actions/get.circuits.circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of circuit type objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,51 +166,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -206,7 +222,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -214,40 +230,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -256,13 +280,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -270,55 +326,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.circuits.circuits.yaml b/actions/get.circuits.circuits.yaml index b97c4dd6..00eea637 100644 --- a/actions/get.circuits.circuits.yaml +++ b/actions/get.circuits.circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of circuit objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. cid: required: false - type: array + type: string description: "Cid" cid__empty: required: false @@ -30,43 +30,51 @@ parameters: description: "Cid is empty/null (boolean)" cid__ic: required: false - type: array + type: string description: "Cid contains (case-insensitive)" cid__ie: required: false - type: array + type: string description: "Cid exact match (case-insensitive)" cid__iew: required: false - type: array + type: string description: "Cid ends with (case-insensitive)" + cid__iregex: + required: false + type: string + description: "Cid" cid__isw: required: false - type: array + type: string description: "Cid starts with (case-sensitive)" cid__n: required: false - type: array + type: string description: "Cid not equal to" cid__nic: required: false - type: array + type: string description: "Cid does not contain (case-insensitive)" cid__nie: required: false - type: array + type: string description: "Cid inverse exact match (case-insensitive)" cid__niew: required: false - type: array + type: string description: "Cid does not end with (case-insensitive)" cid__nisw: required: false - type: array + type: string description: "Cid does not start with (case-sensitive)" + cid__regex: + required: false + type: string + description: "Cid" commit_rate: required: false - type: array + type: integer description: "Commit_rate" commit_rate__empty: required: false @@ -74,75 +82,75 @@ parameters: description: "Commit_rate is empty/null (boolean)" commit_rate__gt: required: false - type: array + type: integer description: "Commit_rate greater than" commit_rate__gte: required: false - type: array + type: integer description: "Commit_rate greater than or equal to" commit_rate__lt: required: false - type: array + type: integer description: "Commit_rate less than" commit_rate__lte: required: false - type: array + type: integer description: "Commit_rate less than or equal to" commit_rate__n: required: false - type: array + type: integer description: "Commit_rate not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -150,7 +158,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -158,43 +166,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" distance: required: false - type: array + type: integer description: "Distance" distance__empty: required: false @@ -202,23 +218,23 @@ parameters: description: "Distance is empty/null (boolean)" distance__gt: required: false - type: array + type: integer description: "Distance greater than" distance__gte: required: false - type: array + type: integer description: "Distance greater than or equal to" distance__lt: required: false - type: array + type: integer description: "Distance less than" distance__lte: required: false - type: array + type: integer description: "Distance less than or equal to" distance__n: required: false - type: array + type: integer description: "Distance not equal to" distance_unit: required: false @@ -227,9 +243,57 @@ parameters: * `m` - Meters * `mi` - Miles * `ft` - Feet" + distance_unit__empty: + required: false + type: boolean + description: "Distance_unit is empty/null (boolean)" + distance_unit__ic: + required: false + type: string + description: "Distance_unit contains (case-insensitive)" + distance_unit__ie: + required: false + type: string + description: "Distance_unit exact match (case-insensitive)" + distance_unit__iew: + required: false + type: string + description: "Distance_unit ends with (case-insensitive)" + distance_unit__iregex: + required: false + type: string + description: "Distance_unit" + distance_unit__isw: + required: false + type: string + description: "Distance_unit starts with (case-sensitive)" + distance_unit__n: + required: false + type: string + description: "Distance_unit not equal to" + distance_unit__nic: + required: false + type: string + description: "Distance_unit does not contain (case-insensitive)" + distance_unit__nie: + required: false + type: string + description: "Distance_unit inverse exact match (case-insensitive)" + distance_unit__niew: + required: false + type: string + description: "Distance_unit does not end with (case-insensitive)" + distance_unit__nisw: + required: false + type: string + description: "Distance_unit does not start with (case-sensitive)" + distance_unit__regex: + required: false + type: string + description: "Distance_unit" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -237,27 +301,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" install_date: required: false - type: array + type: string description: "Install_date" install_date__empty: required: false @@ -265,51 +329,51 @@ parameters: description: "Install_date is empty/null (boolean)" install_date__gt: required: false - type: array + type: string description: "Install_date greater than" install_date__gte: required: false - type: array + type: string description: "Install_date greater than or equal to" install_date__lt: required: false - type: array + type: string description: "Install_date less than" install_date__lte: required: false - type: array + type: string description: "Install_date less than or equal to" install_date__n: required: false - type: array + type: string description: "Install_date not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -317,11 +381,11 @@ parameters: description: "Number of results to return per page." location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" modified_by_request: required: false @@ -335,45 +399,77 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" provider: required: false - type: array + type: string description: "Provider (slug)" provider__n: required: false - type: array + type: string description: "Provider not equal to" provider_account: required: false - type: array + type: string description: "Provider account (account)" provider_account__n: required: false - type: array + type: string description: "Provider_account not equal to" provider_account_id: required: false - type: array + type: integer description: "Provider account (ID)" provider_account_id__n: required: false - type: array + type: integer description: "Provider_account_id not equal to" provider_id: required: false - type: array + type: integer description: "Provider (ID)" provider_id__n: required: false - type: array + type: integer description: "Provider_id not equal to" provider_network_id: required: false - type: array + type: integer description: "Provider network (ID)" provider_network_id__n: required: false - type: array + type: integer description: "Provider_network_id not equal to" q: required: false @@ -381,55 +477,59 @@ parameters: description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -437,99 +537,107 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" termination_a_id: required: false - type: array + type: integer description: "Termination A (ID)" termination_a_id__n: required: false - type: array + type: integer description: "Termination_a_id not equal to" termination_date: required: false - type: array + type: string description: "Termination_date" termination_date__empty: required: false @@ -537,47 +645,47 @@ parameters: description: "Termination_date is empty/null (boolean)" termination_date__gt: required: false - type: array + type: string description: "Termination_date greater than" termination_date__gte: required: false - type: array + type: string description: "Termination_date greater than or equal to" termination_date__lt: required: false - type: array + type: string description: "Termination_date less than" termination_date__lte: required: false - type: array + type: string description: "Termination_date less than or equal to" termination_date__n: required: false - type: array + type: string description: "Termination_date not equal to" termination_z_id: required: false - type: array + type: integer description: "Termination A (ID)" termination_z_id__n: required: false - type: array + type: integer description: "Termination_z_id not equal to" type: required: false - type: array + type: string description: "Circuit type (slug)" type__n: required: false - type: array + type: string description: "Type not equal to" type_id: required: false - type: array + type: integer description: "Circuit type (ID)" type_id__n: required: false - type: array + type: integer description: "Type_id not equal to" updated_by_request: required: false diff --git a/actions/get.circuits.provider_accounts.yaml b/actions/get.circuits.provider_accounts.yaml index 45f02b16..28927249 100644 --- a/actions/get.circuits.provider_accounts.yaml +++ b/actions/get.circuits.provider_accounts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of provider account objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. account: required: false - type: array + type: string description: "Account" account__empty: required: false @@ -30,91 +30,99 @@ parameters: description: "Account is empty/null (boolean)" account__ic: required: false - type: array + type: string description: "Account contains (case-insensitive)" account__ie: required: false - type: array + type: string description: "Account exact match (case-insensitive)" account__iew: required: false - type: array + type: string description: "Account ends with (case-insensitive)" + account__iregex: + required: false + type: string + description: "Account" account__isw: required: false - type: array + type: string description: "Account starts with (case-sensitive)" account__n: required: false - type: array + type: string description: "Account not equal to" account__nic: required: false - type: array + type: string description: "Account does not contain (case-insensitive)" account__nie: required: false - type: array + type: string description: "Account inverse exact match (case-insensitive)" account__niew: required: false - type: array + type: string description: "Account does not end with (case-insensitive)" account__nisw: required: false - type: array + type: string description: "Account does not start with (case-sensitive)" + account__regex: + required: false + type: string + description: "Account" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -122,7 +130,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -130,43 +138,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -174,51 +190,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -230,7 +246,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -238,40 +254,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -280,41 +304,77 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" provider: required: false - type: array + type: string description: "Provider (slug)" provider__n: required: false - type: array + type: string description: "Provider not equal to" provider_id: required: false - type: array + type: integer description: "Provider (ID)" provider_id__n: required: false - type: array + type: integer description: "Provider_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.circuits.provider_networks.yaml b/actions/get.circuits.provider_networks.yaml index d5b319cb..656784e3 100644 --- a/actions/get.circuits.provider_networks.yaml +++ b/actions/get.circuits.provider_networks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of provider network objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,21 +228,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" provider: required: false - type: array + type: string description: "Provider (slug)" provider__n: required: false - type: array + type: string description: "Provider not equal to" provider_id: required: false - type: array + type: integer description: "Provider (ID)" provider_id__n: required: false - type: array + type: integer description: "Provider_id not equal to" q: required: false @@ -234,7 +282,7 @@ parameters: description: "Search" service_id: required: false - type: array + type: string description: "Service_id" service_id__empty: required: false @@ -242,55 +290,67 @@ parameters: description: "Service_id is empty/null (boolean)" service_id__ic: required: false - type: array + type: string description: "Service_id contains (case-insensitive)" service_id__ie: required: false - type: array + type: string description: "Service_id exact match (case-insensitive)" service_id__iew: required: false - type: array + type: string description: "Service_id ends with (case-insensitive)" + service_id__iregex: + required: false + type: string + description: "Service_id" service_id__isw: required: false - type: array + type: string description: "Service_id starts with (case-sensitive)" service_id__n: required: false - type: array + type: string description: "Service_id not equal to" service_id__nic: required: false - type: array + type: string description: "Service_id does not contain (case-insensitive)" service_id__nie: required: false - type: array + type: string description: "Service_id inverse exact match (case-insensitive)" service_id__niew: required: false - type: array + type: string description: "Service_id does not end with (case-insensitive)" service_id__nisw: required: false - type: array + type: string description: "Service_id does not start with (case-sensitive)" + service_id__regex: + required: false + type: string + description: "Service_id" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.circuits.providers.yaml b/actions/get.circuits.providers.yaml index 09995595..d691c306 100644 --- a/actions/get.circuits.providers.yaml +++ b/actions/get.circuits.providers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of provider objects." enabled: true entry_point: run.py @@ -22,71 +22,71 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. asn: required: false - type: array + type: integer description: "ASN" asn__n: required: false - type: array + type: integer description: "Asn not equal to" asn_id: required: false - type: array + type: integer description: "ASN (ID)" asn_id__n: required: false - type: array + type: integer description: "Asn_id not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -94,7 +94,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -102,43 +102,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -146,51 +154,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -202,7 +210,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -210,40 +218,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -252,61 +268,93 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -314,55 +362,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.circuits.virtual_circuit_terminations.paths.yaml b/actions/get.circuits.virtual_circuit_terminations.paths.yaml index bdd96e37..1e00a52a 100644 --- a/actions/get.circuits.virtual_circuit_terminations.paths.yaml +++ b/actions/get.circuits.virtual_circuit_terminations.paths.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Return all CablePaths which traverse a given pass-through port." enabled: true entry_point: run.py diff --git a/actions/get.circuits.virtual_circuit_terminations.yaml b/actions/get.circuits.virtual_circuit_terminations.yaml index 801a8c8d..3936f6be 100644 --- a/actions/get.circuits.virtual_circuit_terminations.yaml +++ b/actions/get.circuits.virtual_circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of virtual circuit termination objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,59 +114,59 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_id: required: false - type: array + type: integer description: "Interface (ID)" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -178,43 +186,43 @@ parameters: description: "Which field to use when ordering the results." provider: required: false - type: array + type: string description: "Provider (slug)" provider__n: required: false - type: array + type: string description: "Provider not equal to" provider_account: required: false - type: array + type: string description: "Provider account (account)" provider_account__n: required: false - type: array + type: string description: "Provider_account not equal to" provider_account_id: required: false - type: array + type: integer description: "Provider account (ID)" provider_account_id__n: required: false - type: array + type: integer description: "Provider_account_id not equal to" provider_id: required: false - type: array + type: integer description: "Provider (ID)" provider_id__n: required: false - type: array + type: integer description: "Provider_id not equal to" provider_network_id: required: false - type: array + type: integer description: "Provider network (ID)" provider_network_id__n: required: false - type: array + type: integer description: "Provider_network_id not equal to" q: required: false @@ -222,7 +230,7 @@ parameters: description: "Search" role: required: false - type: array + type: string description: "Role" role__empty: required: false @@ -230,55 +238,67 @@ parameters: description: "Role is empty/null (boolean)" role__ic: required: false - type: array + type: string description: "Role contains (case-insensitive)" role__ie: required: false - type: array + type: string description: "Role exact match (case-insensitive)" role__iew: required: false - type: array + type: string description: "Role ends with (case-insensitive)" + role__iregex: + required: false + type: string + description: "Role" role__isw: required: false - type: array + type: string description: "Role starts with (case-sensitive)" role__n: required: false - type: array + type: string description: "Role not equal to" role__nic: required: false - type: array + type: string description: "Role does not contain (case-insensitive)" role__nie: required: false - type: array + type: string description: "Role inverse exact match (case-insensitive)" role__niew: required: false - type: array + type: string description: "Role does not end with (case-insensitive)" role__nisw: required: false - type: array + type: string description: "Role does not start with (case-sensitive)" + role__regex: + required: false + type: string + description: "Role" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -286,11 +306,11 @@ parameters: description: "Updated_by_request" virtual_circuit_id: required: false - type: array + type: integer description: "Virtual circuit" virtual_circuit_id__n: required: false - type: array + type: integer description: "Virtual_circuit_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.circuits.virtual_circuit_types.yaml b/actions/get.circuits.virtual_circuit_types.yaml index b67592a0..5d33f55d 100644 --- a/actions/get.circuits.virtual_circuit_types.yaml +++ b/actions/get.circuits.virtual_circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of virtual circuit type objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,51 +166,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -206,7 +222,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -214,40 +230,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -256,13 +280,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -270,55 +326,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.circuits.virtual_circuits.yaml b/actions/get.circuits.virtual_circuits.yaml index 7938d40e..8ec1d79e 100644 --- a/actions/get.circuits.virtual_circuits.yaml +++ b/actions/get.circuits.virtual_circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of virtual circuit objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. cid: required: false - type: array + type: string description: "Cid" cid__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Cid is empty/null (boolean)" cid__ic: required: false - type: array + type: string description: "Cid contains (case-insensitive)" cid__ie: required: false - type: array + type: string description: "Cid exact match (case-insensitive)" cid__iew: required: false - type: array + type: string description: "Cid ends with (case-insensitive)" + cid__iregex: + required: false + type: string + description: "Cid" cid__isw: required: false - type: array + type: string description: "Cid starts with (case-sensitive)" cid__n: required: false - type: array + type: string description: "Cid not equal to" cid__nic: required: false - type: array + type: string description: "Cid does not contain (case-insensitive)" cid__nie: required: false - type: array + type: string description: "Cid inverse exact match (case-insensitive)" cid__niew: required: false - type: array + type: string description: "Cid does not end with (case-insensitive)" cid__nisw: required: false - type: array + type: string description: "Cid does not start with (case-sensitive)" + cid__regex: + required: false + type: string + description: "Cid" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,51 +166,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -212,53 +228,89 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" provider: required: false - type: array + type: string description: "Provider (slug)" provider__n: required: false - type: array + type: string description: "Provider not equal to" provider_account: required: false - type: array + type: string description: "Provider account (account)" provider_account__n: required: false - type: array + type: string description: "Provider_account not equal to" provider_account_id: required: false - type: array + type: integer description: "Provider account (ID)" provider_account_id__n: required: false - type: array + type: integer description: "Provider_account_id not equal to" provider_id: required: false - type: array + type: integer description: "Provider (ID)" provider_id__n: required: false - type: array + type: integer description: "Provider_id not equal to" provider_network_id: required: false - type: array + type: integer description: "Provider network (ID)" provider_network_id__n: required: false - type: array + type: integer description: "Provider_network_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -266,103 +318,111 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Virtual circuit type (slug)" type__n: required: false - type: array + type: string description: "Type not equal to" type_id: required: false - type: array + type: integer description: "Virtual circuit type (ID)" type_id__n: required: false - type: array + type: integer description: "Type_id not equal to" updated_by_request: required: false diff --git a/actions/get.core.data_files.yaml b/actions/get.core.data_files.yaml index 58e605dc..b7142298 100644 --- a/actions/get.core.data_files.yaml +++ b/actions/get.core.data_files.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of data file objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" hash: required: false - type: array + type: string description: "Hash" hash__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Hash is empty/null (boolean)" hash__ic: required: false - type: array + type: string description: "Hash contains (case-insensitive)" hash__ie: required: false - type: array + type: string description: "Hash exact match (case-insensitive)" hash__iew: required: false - type: array + type: string description: "Hash ends with (case-insensitive)" + hash__iregex: + required: false + type: string + description: "Hash" hash__isw: required: false - type: array + type: string description: "Hash starts with (case-sensitive)" hash__n: required: false - type: array + type: string description: "Hash not equal to" hash__nic: required: false - type: array + type: string description: "Hash does not contain (case-insensitive)" hash__nie: required: false - type: array + type: string description: "Hash inverse exact match (case-insensitive)" hash__niew: required: false - type: array + type: string description: "Hash does not end with (case-insensitive)" hash__nisw: required: false - type: array + type: string description: "Hash does not start with (case-sensitive)" + hash__regex: + required: false + type: string + description: "Hash" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -170,7 +178,7 @@ parameters: description: "Which field to use when ordering the results." path: required: false - type: array + type: string description: "Path" path__empty: required: false @@ -178,47 +186,55 @@ parameters: description: "Path is empty/null (boolean)" path__ic: required: false - type: array + type: string description: "Path contains (case-insensitive)" path__ie: required: false - type: array + type: string description: "Path exact match (case-insensitive)" path__iew: required: false - type: array + type: string description: "Path ends with (case-insensitive)" + path__iregex: + required: false + type: string + description: "Path" path__isw: required: false - type: array + type: string description: "Path starts with (case-sensitive)" path__n: required: false - type: array + type: string description: "Path not equal to" path__nic: required: false - type: array + type: string description: "Path does not contain (case-insensitive)" path__nie: required: false - type: array + type: string description: "Path inverse exact match (case-insensitive)" path__niew: required: false - type: array + type: string description: "Path does not end with (case-insensitive)" path__nisw: required: false - type: array + type: string description: "Path does not start with (case-sensitive)" + path__regex: + required: false + type: string + description: "Path" q: required: false type: string description: "Q" size: required: false - type: array + type: integer description: "Size" size__empty: required: false @@ -226,40 +242,44 @@ parameters: description: "Size is empty/null (boolean)" size__gt: required: false - type: array + type: integer description: "Size greater than" size__gte: required: false - type: array + type: integer description: "Size greater than or equal to" size__lt: required: false - type: array + type: integer description: "Size less than" size__lte: required: false - type: array + type: integer description: "Size less than or equal to" size__n: required: false - type: array + type: integer description: "Size not equal to" source: required: false - type: array + type: string description: "Data source (name)" source__n: required: false - type: array + type: string description: "Source not equal to" source_id: required: false - type: array + type: integer description: "Data source (ID)" source_id__n: required: false - type: array + type: integer description: "Source_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string diff --git a/actions/get.core.data_sources.yaml b/actions/get.core.data_sources.yaml index 7f31accb..bcc95de7 100644 --- a/actions/get.core.data_sources.yaml +++ b/actions/get.core.data_sources.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of data source objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,47 +62,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" enabled: required: false type: boolean description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -110,27 +118,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_synced: required: false - type: array + type: string description: "Last_synced" last_synced__empty: required: false @@ -138,51 +146,51 @@ parameters: description: "Last_synced is empty/null (boolean)" last_synced__gt: required: false - type: array + type: string description: "Last_synced greater than" last_synced__gte: required: false - type: array + type: string description: "Last_synced greater than or equal to" last_synced__lt: required: false - type: array + type: string description: "Last_synced less than" last_synced__lte: required: false - type: array + type: string description: "Last_synced less than or equal to" last_synced__n: required: false - type: array + type: string description: "Last_synced not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -194,7 +202,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -202,40 +210,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -244,13 +260,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" source_url: required: false - type: array + type: string description: "Source_url" source_url__empty: required: false @@ -258,43 +306,55 @@ parameters: description: "Source_url is empty/null (boolean)" source_url__ic: required: false - type: array + type: string description: "Source_url contains (case-insensitive)" source_url__ie: required: false - type: array + type: string description: "Source_url exact match (case-insensitive)" source_url__iew: required: false - type: array + type: string description: "Source_url ends with (case-insensitive)" + source_url__iregex: + required: false + type: string + description: "Source_url" source_url__isw: required: false - type: array + type: string description: "Source_url starts with (case-sensitive)" source_url__n: required: false - type: array + type: string description: "Source_url not equal to" source_url__nic: required: false - type: array + type: string description: "Source_url does not contain (case-insensitive)" source_url__nie: required: false - type: array + type: string description: "Source_url inverse exact match (case-insensitive)" source_url__niew: required: false - type: array + type: string description: "Source_url does not end with (case-insensitive)" source_url__nisw: required: false - type: array + type: string description: "Source_url does not start with (case-sensitive)" + source_url__regex: + required: false + type: string + description: "Source_url" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -302,99 +362,115 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" sync_interval: required: false - type: array + type: integer description: "Sync_interval" sync_interval__ic: required: false - type: array + type: integer description: "Sync_interval contains (case-insensitive)" sync_interval__ie: required: false - type: array + type: integer description: "Sync_interval exact match (case-insensitive)" sync_interval__iew: required: false - type: array + type: integer description: "Sync_interval ends with (case-insensitive)" + sync_interval__iregex: + required: false + type: integer + description: "Sync_interval" sync_interval__isw: required: false - type: array + type: integer description: "Sync_interval starts with (case-sensitive)" sync_interval__n: required: false - type: array + type: integer description: "Sync_interval not equal to" sync_interval__nic: required: false - type: array + type: integer description: "Sync_interval does not contain (case-insensitive)" sync_interval__nie: required: false - type: array + type: integer description: "Sync_interval inverse exact match (case-insensitive)" sync_interval__niew: required: false - type: array + type: integer description: "Sync_interval does not end with (case-insensitive)" sync_interval__nisw: required: false - type: array + type: integer description: "Sync_interval does not start with (case-sensitive)" + sync_interval__regex: + required: false + type: integer + description: "Sync_interval" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -402,40 +478,48 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.core.jobs.yaml b/actions/get.core.jobs.yaml index c43dcb14..07491961 100644 --- a/actions/get.core.jobs.yaml +++ b/actions/get.core.jobs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Retrieve a list of job results" enabled: true entry_point: run.py @@ -46,7 +46,7 @@ parameters: description: "Created" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -54,27 +54,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interval: required: false - type: array + type: integer description: "Interval" interval__empty: required: false @@ -82,23 +82,23 @@ parameters: description: "Interval is empty/null (boolean)" interval__gt: required: false - type: array + type: integer description: "Interval greater than" interval__gte: required: false - type: array + type: integer description: "Interval greater than or equal to" interval__lt: required: false - type: array + type: integer description: "Interval less than" interval__lte: required: false - type: array + type: integer description: "Interval less than or equal to" interval__n: required: false - type: array + type: integer description: "Interval not equal to" job_id: required: false @@ -110,7 +110,7 @@ parameters: description: "Number of results to return per page." name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -118,43 +118,51 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_id: required: false - type: array + type: integer description: "Object_id" object_id__empty: required: false @@ -162,32 +170,40 @@ parameters: description: "Object_id is empty/null (boolean)" object_id__gt: required: false - type: array + type: integer description: "Object_id greater than" object_id__gte: required: false - type: array + type: integer description: "Object_id greater than or equal to" object_id__lt: required: false - type: array + type: integer description: "Object_id less than" object_id__lte: required: false - type: array + type: integer description: "Object_id less than or equal to" object_id__n: required: false - type: array + type: integer description: "Object_id not equal to" object_type: required: false - type: integer + type: string description: "Object_type" object_type__n: required: false - type: integer + type: string description: "Object_type not equal to" + object_type_id: + required: false + type: integer + description: "Object_type_id" + object_type_id__n: + required: false + type: integer + description: "Object_type_id not equal to" offset: required: false type: integer @@ -200,6 +216,58 @@ parameters: required: false type: string description: "Search" + queue_name: + required: false + type: string + description: "Queue_name" + queue_name__empty: + required: false + type: boolean + description: "Queue_name is empty/null (boolean)" + queue_name__ic: + required: false + type: string + description: "Queue_name contains (case-insensitive)" + queue_name__ie: + required: false + type: string + description: "Queue_name exact match (case-insensitive)" + queue_name__iew: + required: false + type: string + description: "Queue_name ends with (case-insensitive)" + queue_name__iregex: + required: false + type: string + description: "Queue_name" + queue_name__isw: + required: false + type: string + description: "Queue_name starts with (case-sensitive)" + queue_name__n: + required: false + type: string + description: "Queue_name not equal to" + queue_name__nic: + required: false + type: string + description: "Queue_name does not contain (case-insensitive)" + queue_name__nie: + required: false + type: string + description: "Queue_name inverse exact match (case-insensitive)" + queue_name__niew: + required: false + type: string + description: "Queue_name does not end with (case-insensitive)" + queue_name__nisw: + required: false + type: string + description: "Queue_name does not start with (case-sensitive)" + queue_name__regex: + required: false + type: string + description: "Queue_name" scheduled: required: false type: string @@ -212,6 +280,10 @@ parameters: required: false type: string description: "Scheduled" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." started: required: false type: string @@ -226,7 +298,7 @@ parameters: description: "Started" status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -234,40 +306,48 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" user: required: false type: integer diff --git a/actions/get.core.object_changes.yaml b/actions/get.core.object_changes.yaml index eb893d53..5b796e95 100644 --- a/actions/get.core.object_changes.yaml +++ b/actions/get.core.object_changes.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Retrieve a list of recent changes." enabled: true entry_point: run.py @@ -26,9 +26,57 @@ parameters: description: "* `create` - Created * `update` - Updated * `delete` - Deleted" + action__empty: + required: false + type: boolean + description: "Action is empty/null (boolean)" + action__ic: + required: false + type: string + description: "Action contains (case-insensitive)" + action__ie: + required: false + type: string + description: "Action exact match (case-insensitive)" + action__iew: + required: false + type: string + description: "Action ends with (case-insensitive)" + action__iregex: + required: false + type: string + description: "Action" + action__isw: + required: false + type: string + description: "Action starts with (case-sensitive)" + action__n: + required: false + type: string + description: "Action not equal to" + action__nic: + required: false + type: string + description: "Action does not contain (case-insensitive)" + action__nie: + required: false + type: string + description: "Action inverse exact match (case-insensitive)" + action__niew: + required: false + type: string + description: "Action does not end with (case-insensitive)" + action__nisw: + required: false + type: string + description: "Action does not start with (case-sensitive)" + action__regex: + required: false + type: string + description: "Action" changed_object_id: required: false - type: array + type: integer description: "Changed_object_id" changed_object_id__empty: required: false @@ -36,23 +84,23 @@ parameters: description: "Changed_object_id is empty/null (boolean)" changed_object_id__gt: required: false - type: array + type: integer description: "Changed_object_id greater than" changed_object_id__gte: required: false - type: array + type: integer description: "Changed_object_id greater than or equal to" changed_object_id__lt: required: false - type: array + type: integer description: "Changed_object_id less than" changed_object_id__lte: required: false - type: array + type: integer description: "Changed_object_id less than or equal to" changed_object_id__n: required: false - type: array + type: integer description: "Changed_object_id not equal to" changed_object_type: required: false @@ -64,15 +112,15 @@ parameters: description: "Changed_object_type not equal to" changed_object_type_id: required: false - type: array + type: integer description: "Changed_object_type_id" changed_object_type_id__n: required: false - type: array + type: integer description: "Changed_object_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -80,23 +128,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" limit: required: false @@ -104,7 +152,7 @@ parameters: description: "Number of results to return per page." object_repr: required: false - type: array + type: string description: "Object_repr" object_repr__empty: required: false @@ -112,40 +160,48 @@ parameters: description: "Object_repr is empty/null (boolean)" object_repr__ic: required: false - type: array + type: string description: "Object_repr contains (case-insensitive)" object_repr__ie: required: false - type: array + type: string description: "Object_repr exact match (case-insensitive)" object_repr__iew: required: false - type: array + type: string description: "Object_repr ends with (case-insensitive)" + object_repr__iregex: + required: false + type: string + description: "Object_repr" object_repr__isw: required: false - type: array + type: string description: "Object_repr starts with (case-sensitive)" object_repr__n: required: false - type: array + type: string description: "Object_repr not equal to" object_repr__nic: required: false - type: array + type: string description: "Object_repr does not contain (case-insensitive)" object_repr__nie: required: false - type: array + type: string description: "Object_repr inverse exact match (case-insensitive)" object_repr__niew: required: false - type: array + type: string description: "Object_repr does not end with (case-insensitive)" object_repr__nisw: required: false - type: array + type: string description: "Object_repr does not start with (case-sensitive)" + object_repr__regex: + required: false + type: string + description: "Object_repr" offset: required: false type: integer @@ -160,7 +216,7 @@ parameters: description: "Search" related_object_id: required: false - type: array + type: integer description: "Related_object_id" related_object_id__empty: required: false @@ -168,36 +224,40 @@ parameters: description: "Related_object_id is empty/null (boolean)" related_object_id__gt: required: false - type: array + type: integer description: "Related_object_id greater than" related_object_id__gte: required: false - type: array + type: integer description: "Related_object_id greater than or equal to" related_object_id__lt: required: false - type: array + type: integer description: "Related_object_id less than" related_object_id__lte: required: false - type: array + type: integer description: "Related_object_id less than or equal to" related_object_id__n: required: false - type: array + type: integer description: "Related_object_id not equal to" related_object_type: required: false - type: integer + type: string description: "Related_object_type" related_object_type__n: required: false - type: integer + type: string description: "Related_object_type not equal to" request_id: required: false type: string description: "Request_id" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." time_after: required: false type: string @@ -208,23 +268,23 @@ parameters: description: "Time_before" user: required: false - type: array + type: string description: "User name" user__n: required: false - type: array + type: string description: "User not equal to" user_id: required: false - type: array + type: integer description: "User (ID)" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" user_name: required: false - type: array + type: string description: "User_name" user_name__empty: required: false @@ -232,40 +292,48 @@ parameters: description: "User_name is empty/null (boolean)" user_name__ic: required: false - type: array + type: string description: "User_name contains (case-insensitive)" user_name__ie: required: false - type: array + type: string description: "User_name exact match (case-insensitive)" user_name__iew: required: false - type: array + type: string description: "User_name ends with (case-insensitive)" + user_name__iregex: + required: false + type: string + description: "User_name" user_name__isw: required: false - type: array + type: string description: "User_name starts with (case-sensitive)" user_name__n: required: false - type: array + type: string description: "User_name not equal to" user_name__nic: required: false - type: array + type: string description: "User_name does not contain (case-insensitive)" user_name__nie: required: false - type: array + type: string description: "User_name inverse exact match (case-insensitive)" user_name__niew: required: false - type: array + type: string description: "User_name does not end with (case-insensitive)" user_name__nisw: required: false - type: array + type: string description: "User_name does not start with (case-sensitive)" + user_name__regex: + required: false + type: string + description: "User_name" save_in_key_store: type: boolean default: false diff --git a/actions/get.core.object_types.yaml b/actions/get.core.object_types.yaml new file mode 100644 index 00000000..d248703a --- /dev/null +++ b/actions/get.core.object_types.yaml @@ -0,0 +1,194 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Read-only list of ObjectTypes." +enabled: true +entry_point: run.py +name: get.core.object_types +parameters: + endpoint_uri: + default: "/core/object-types/" + immutable: true + type: string + http_verb: + default: get + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + app_label: + required: false + type: string + description: "App_label" + app_label__empty: + required: false + type: boolean + description: "App_label is empty/null (boolean)" + app_label__ic: + required: false + type: string + description: "App_label contains (case-insensitive)" + app_label__ie: + required: false + type: string + description: "App_label exact match (case-insensitive)" + app_label__iew: + required: false + type: string + description: "App_label ends with (case-insensitive)" + app_label__iregex: + required: false + type: string + description: "App_label" + app_label__isw: + required: false + type: string + description: "App_label starts with (case-sensitive)" + app_label__n: + required: false + type: string + description: "App_label not equal to" + app_label__nic: + required: false + type: string + description: "App_label does not contain (case-insensitive)" + app_label__nie: + required: false + type: string + description: "App_label inverse exact match (case-insensitive)" + app_label__niew: + required: false + type: string + description: "App_label does not end with (case-insensitive)" + app_label__nisw: + required: false + type: string + description: "App_label does not start with (case-sensitive)" + app_label__regex: + required: false + type: string + description: "App_label" + features: + required: false + type: string + description: "Features" + id: + required: false + type: integer + description: "Id" + id__empty: + required: false + type: boolean + description: "Id is empty/null (boolean)" + id__gt: + required: false + type: integer + description: "Id greater than" + id__gte: + required: false + type: integer + description: "Id greater than or equal to" + id__lt: + required: false + type: integer + description: "Id less than" + id__lte: + required: false + type: integer + description: "Id less than or equal to" + id__n: + required: false + type: integer + description: "Id not equal to" + limit: + required: false + type: integer + description: "Number of results to return per page." + model: + required: false + type: string + description: "Model" + model__empty: + required: false + type: boolean + description: "Model is empty/null (boolean)" + model__ic: + required: false + type: string + description: "Model contains (case-insensitive)" + model__ie: + required: false + type: string + description: "Model exact match (case-insensitive)" + model__iew: + required: false + type: string + description: "Model ends with (case-insensitive)" + model__iregex: + required: false + type: string + description: "Model" + model__isw: + required: false + type: string + description: "Model starts with (case-sensitive)" + model__n: + required: false + type: string + description: "Model not equal to" + model__nic: + required: false + type: string + description: "Model does not contain (case-insensitive)" + model__nie: + required: false + type: string + description: "Model inverse exact match (case-insensitive)" + model__niew: + required: false + type: string + description: "Model does not end with (case-insensitive)" + model__nisw: + required: false + type: string + description: "Model does not start with (case-sensitive)" + model__regex: + required: false + type: string + description: "Model" + offset: + required: false + type: integer + description: "The initial index from which to return the results." + ordering: + required: false + type: string + description: "Which field to use when ordering the results." + public: + required: false + type: boolean + description: "Public" + q: + required: false + type: string + description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + save_in_key_store: + type: boolean + default: false + description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. + save_in_key_store_key_name: + type: string + description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. + save_in_key_store_ttl: + type: integer + default: 60 + description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. +runner_type: python-script diff --git a/actions/get.dcim.cable_bundles.yaml b/actions/get.dcim.cable_bundles.yaml new file mode 100644 index 00000000..fd67a81a --- /dev/null +++ b/actions/get.dcim.cable_bundles.yaml @@ -0,0 +1,302 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Get a list of cable bundle objects." +enabled: true +entry_point: run.py +name: get.dcim.cable_bundles +parameters: + endpoint_uri: + default: "/dcim/cable-bundles/" + immutable: true + type: string + http_verb: + default: get + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + created: + required: false + type: string + description: "Created" + created__empty: + required: false + type: string + description: "Created is empty/null (boolean)" + created__gt: + required: false + type: string + description: "Created greater than" + created__gte: + required: false + type: string + description: "Created greater than or equal to" + created__lt: + required: false + type: string + description: "Created less than" + created__lte: + required: false + type: string + description: "Created less than or equal to" + created__n: + required: false + type: string + description: "Created not equal to" + created_by_request: + required: false + type: string + description: "Created_by_request" + description: + required: false + type: string + description: "Description" + description__empty: + required: false + type: boolean + description: "Description is empty/null (boolean)" + description__ic: + required: false + type: string + description: "Description contains (case-insensitive)" + description__ie: + required: false + type: string + description: "Description exact match (case-insensitive)" + description__iew: + required: false + type: string + description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" + description__isw: + required: false + type: string + description: "Description starts with (case-sensitive)" + description__n: + required: false + type: string + description: "Description not equal to" + description__nic: + required: false + type: string + description: "Description does not contain (case-insensitive)" + description__nie: + required: false + type: string + description: "Description inverse exact match (case-insensitive)" + description__niew: + required: false + type: string + description: "Description does not end with (case-insensitive)" + description__nisw: + required: false + type: string + description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + id: + required: false + type: integer + description: "Id" + id__empty: + required: false + type: boolean + description: "Id is empty/null (boolean)" + id__gt: + required: false + type: integer + description: "Id greater than" + id__gte: + required: false + type: integer + description: "Id greater than or equal to" + id__lt: + required: false + type: integer + description: "Id less than" + id__lte: + required: false + type: integer + description: "Id less than or equal to" + id__n: + required: false + type: integer + description: "Id not equal to" + last_updated: + required: false + type: string + description: "Last_updated" + last_updated__empty: + required: false + type: string + description: "Last_updated is empty/null (boolean)" + last_updated__gt: + required: false + type: string + description: "Last_updated greater than" + last_updated__gte: + required: false + type: string + description: "Last_updated greater than or equal to" + last_updated__lt: + required: false + type: string + description: "Last_updated less than" + last_updated__lte: + required: false + type: string + description: "Last_updated less than or equal to" + last_updated__n: + required: false + type: string + description: "Last_updated not equal to" + limit: + required: false + type: integer + description: "Number of results to return per page." + modified_by_request: + required: false + type: string + description: "Modified_by_request" + name: + required: false + type: string + description: "Name" + name__empty: + required: false + type: boolean + description: "Name is empty/null (boolean)" + name__ic: + required: false + type: string + description: "Name contains (case-insensitive)" + name__ie: + required: false + type: string + description: "Name exact match (case-insensitive)" + name__iew: + required: false + type: string + description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" + name__isw: + required: false + type: string + description: "Name starts with (case-sensitive)" + name__n: + required: false + type: string + description: "Name not equal to" + name__nic: + required: false + type: string + description: "Name does not contain (case-insensitive)" + name__nie: + required: false + type: string + description: "Name inverse exact match (case-insensitive)" + name__niew: + required: false + type: string + description: "Name does not end with (case-insensitive)" + name__nisw: + required: false + type: string + description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" + offset: + required: false + type: integer + description: "The initial index from which to return the results." + ordering: + required: false + type: string + description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + q: + required: false + type: string + description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + tag: + required: false + type: string + description: "Tag" + tag__n: + required: false + type: string + description: "Tag not equal to" + tag_id: + required: false + type: integer + description: "Tag_id" + tag_id__n: + required: false + type: integer + description: "Tag_id not equal to" + updated_by_request: + required: false + type: string + description: "Updated_by_request" + save_in_key_store: + type: boolean + default: false + description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. + save_in_key_store_key_name: + type: string + description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. + save_in_key_store_ttl: + type: integer + default: 60 + description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. +runner_type: python-script diff --git a/actions/get.dcim.cable_terminations.yaml b/actions/get.dcim.cable_terminations.yaml index c75b82e9..30c403e4 100644 --- a/actions/get.dcim.cable_terminations.yaml +++ b/actions/get.dcim.cable_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of cable termination objects." enabled: true entry_point: run.py @@ -33,33 +33,81 @@ parameters: type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -67,7 +115,7 @@ parameters: description: "Created_by_request" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -75,51 +123,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -137,9 +185,13 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." termination_id: required: false - type: array + type: integer description: "Termination_id" termination_id__empty: required: false @@ -147,23 +199,23 @@ parameters: description: "Termination_id is empty/null (boolean)" termination_id__gt: required: false - type: array + type: integer description: "Termination_id greater than" termination_id__gte: required: false - type: array + type: integer description: "Termination_id greater than or equal to" termination_id__lt: required: false - type: array + type: integer description: "Termination_id less than" termination_id__lte: required: false - type: array + type: integer description: "Termination_id less than or equal to" termination_id__n: required: false - type: array + type: integer description: "Termination_id not equal to" termination_type: required: false diff --git a/actions/get.dcim.cables.yaml b/actions/get.dcim.cables.yaml index 96131997..1df784d1 100644 --- a/actions/get.dcim.cables.yaml +++ b/actions/get.dcim.cables.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of cable objects." enabled: true entry_point: run.py @@ -20,13 +20,29 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + bundle: + required: false + type: string + description: "Cable bundle (name)" + bundle__n: + required: false + type: string + description: "Bundle not equal to" + bundle_id: + required: false + type: integer + description: "Cable bundle (ID)" + bundle_id__n: + required: false + type: integer + description: "Bundle_id not equal to" circuittermination_id: required: false - type: array + type: integer description: "Circuittermination_id" color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -34,75 +50,83 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" consoleport_id: required: false - type: array + type: integer description: "Consoleport_id" consoleserverport_id: required: false - type: array + type: integer description: "Consoleserverport_id" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -110,7 +134,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -118,55 +142,63 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device" device_id: required: false - type: array + type: integer description: "Device_id" frontport_id: required: false - type: array + type: integer description: "Frontport_id" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -174,31 +206,31 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_id: required: false - type: array + type: integer description: "Interface_id" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -206,71 +238,79 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" length: required: false - type: array + type: integer description: "Length" length__empty: required: false @@ -278,23 +318,23 @@ parameters: description: "Length is empty/null (boolean)" length__gt: required: false - type: array + type: integer description: "Length greater than" length__gte: required: false - type: array + type: integer description: "Length greater than or equal to" length__lt: required: false - type: array + type: integer description: "Length less than" length__lte: required: false - type: array + type: integer description: "Length less than or equal to" length__n: required: false - type: array + type: integer description: "Length not equal to" length_unit: required: false @@ -305,17 +345,65 @@ parameters: * `mi` - Miles * `ft` - Feet * `in` - Inches" + length_unit__empty: + required: false + type: boolean + description: "Length_unit is empty/null (boolean)" + length_unit__ic: + required: false + type: string + description: "Length_unit contains (case-insensitive)" + length_unit__ie: + required: false + type: string + description: "Length_unit exact match (case-insensitive)" + length_unit__iew: + required: false + type: string + description: "Length_unit ends with (case-insensitive)" + length_unit__iregex: + required: false + type: string + description: "Length_unit" + length_unit__isw: + required: false + type: string + description: "Length_unit starts with (case-sensitive)" + length_unit__n: + required: false + type: string + description: "Length_unit not equal to" + length_unit__nic: + required: false + type: string + description: "Length_unit does not contain (case-insensitive)" + length_unit__nie: + required: false + type: string + description: "Length_unit inverse exact match (case-insensitive)" + length_unit__niew: + required: false + type: string + description: "Length_unit does not end with (case-insensitive)" + length_unit__nisw: + required: false + type: string + description: "Length_unit does not start with (case-sensitive)" + length_unit__regex: + required: false + type: string + description: "Length_unit" limit: required: false type: integer description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location" location_id: required: false - type: array + type: integer description: "Location_id" modified_by_request: required: false @@ -329,45 +417,133 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" powerfeed_id: required: false - type: array + type: integer description: "Powerfeed_id" poweroutlet_id: required: false - type: array + type: integer description: "Poweroutlet_id" powerport_id: required: false - type: array + type: integer description: "Powerport_id" + profile: + required: false + type: string + description: "Profile" + profile__empty: + required: false + type: boolean + description: "Profile is empty/null (boolean)" + profile__ic: + required: false + type: string + description: "Profile contains (case-insensitive)" + profile__ie: + required: false + type: string + description: "Profile exact match (case-insensitive)" + profile__iew: + required: false + type: string + description: "Profile ends with (case-insensitive)" + profile__iregex: + required: false + type: string + description: "Profile" + profile__isw: + required: false + type: string + description: "Profile starts with (case-sensitive)" + profile__n: + required: false + type: string + description: "Profile not equal to" + profile__nic: + required: false + type: string + description: "Profile does not contain (case-insensitive)" + profile__nie: + required: false + type: string + description: "Profile inverse exact match (case-insensitive)" + profile__niew: + required: false + type: string + description: "Profile does not end with (case-insensitive)" + profile__nisw: + required: false + type: string + description: "Profile does not start with (case-sensitive)" + profile__regex: + required: false + type: string + description: "Profile" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack" rack_id: required: false - type: array + type: integer description: "Rack_id" rearport_id: required: false - type: array + type: integer description: "Rearport_id" site: required: false - type: array + type: string description: "Site" site_id: required: false - type: array + type: integer description: "Site_id" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -375,91 +551,99 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" termination_a_id: required: false - type: array + type: integer description: "Termination_a_id" termination_a_type: required: false @@ -471,7 +655,7 @@ parameters: description: "Termination_a_type not equal to" termination_b_id: required: false - type: array + type: integer description: "Termination_b_id" termination_b_type: required: false @@ -483,7 +667,7 @@ parameters: description: "Termination_b_type not equal to" type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -491,40 +675,48 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" unterminated: required: false type: boolean diff --git a/actions/get.dcim.connected_device.yaml b/actions/get.dcim.connected_device.yaml index 7c229acf..722dcad8 100644 --- a/actions/get.dcim.connected_device.yaml +++ b/actions/get.dcim.connected_device.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 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: diff --git a/actions/get.dcim.console_port_templates.yaml b/actions/get.dcim.console_port_templates.yaml index 7293b1fa..c78697b1 100644 --- a/actions/get.dcim.console_port_templates.yaml +++ b/actions/get.dcim.console_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of console port template objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,51 +62,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -114,27 +122,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -142,67 +150,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -214,15 +230,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -230,40 +246,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -276,12 +300,64 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false type: string description: "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')] * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')] * `Other` - [('other', 'Other')]" + type__empty: + required: false + type: boolean + description: "Type is empty/null (boolean)" + type__ic: + required: false + type: string + description: "Type contains (case-insensitive)" + type__ie: + required: false + type: string + description: "Type exact match (case-insensitive)" + type__iew: + required: false + type: string + description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" + type__isw: + required: false + type: string + description: "Type starts with (case-sensitive)" + type__n: + required: false + type: string + description: "Type not equal to" + type__nic: + required: false + type: string + description: "Type does not contain (case-insensitive)" + type__nie: + required: false + type: string + description: "Type inverse exact match (case-insensitive)" + type__niew: + required: false + type: string + description: "Type does not end with (case-insensitive)" + type__nisw: + required: false + type: string + description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.dcim.console_ports.trace.yaml b/actions/get.dcim.console_ports.trace.yaml index 2a9113a5..0c0d055a 100644 --- a/actions/get.dcim.console_ports.trace.yaml +++ b/actions/get.dcim.console_ports.trace.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." enabled: true entry_point: run.py diff --git a/actions/get.dcim.console_ports.yaml b/actions/get.dcim.console_ports.yaml index 38cd3fc2..d8d744a3 100644 --- a/actions/get.dcim.console_ports.yaml +++ b/actions/get.dcim.console_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of console port objects." enabled: true entry_point: run.py @@ -20,18 +20,94 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -43,31 +119,31 @@ parameters: description: "Connected" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -75,7 +151,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -83,75 +159,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -159,59 +243,67 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -219,27 +311,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -247,67 +339,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -315,19 +415,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" mark_connected: required: false @@ -339,15 +439,15 @@ parameters: description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -355,40 +455,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -401,73 +509,105 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" speed: required: false @@ -482,25 +622,89 @@ parameters: * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps" + speed__ic: + required: false + type: integer + description: "Speed contains (case-insensitive)" + speed__ie: + required: false + type: integer + description: "Speed exact match (case-insensitive)" + speed__iew: + required: false + type: integer + description: "Speed ends with (case-insensitive)" + speed__iregex: + required: false + type: integer + description: "Speed" + speed__isw: + required: false + type: integer + description: "Speed starts with (case-sensitive)" + speed__n: + required: false + type: integer + description: "Speed not equal to" + speed__nic: + required: false + type: integer + description: "Speed does not contain (case-insensitive)" + speed__nie: + required: false + type: integer + description: "Speed inverse exact match (case-insensitive)" + speed__niew: + required: false + type: integer + description: "Speed does not end with (case-insensitive)" + speed__nisw: + required: false + type: integer + description: "Speed does not start with (case-sensitive)" + speed__regex: + required: false + type: integer + description: "Speed" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Physical port type" type__empty: required: false @@ -508,59 +712,67 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Physical port type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Physical port type" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.console_server_port_templates.yaml b/actions/get.dcim.console_server_port_templates.yaml index 962ec868..16c93721 100644 --- a/actions/get.dcim.console_server_port_templates.yaml +++ b/actions/get.dcim.console_server_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of console server port template objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,51 +62,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -114,27 +122,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -142,67 +150,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -214,15 +230,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -230,40 +246,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -276,12 +300,64 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false type: string description: "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')] * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')] * `Other` - [('other', 'Other')]" + type__empty: + required: false + type: boolean + description: "Type is empty/null (boolean)" + type__ic: + required: false + type: string + description: "Type contains (case-insensitive)" + type__ie: + required: false + type: string + description: "Type exact match (case-insensitive)" + type__iew: + required: false + type: string + description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" + type__isw: + required: false + type: string + description: "Type starts with (case-sensitive)" + type__n: + required: false + type: string + description: "Type not equal to" + type__nic: + required: false + type: string + description: "Type does not contain (case-insensitive)" + type__nie: + required: false + type: string + description: "Type inverse exact match (case-insensitive)" + type__niew: + required: false + type: string + description: "Type does not end with (case-insensitive)" + type__nisw: + required: false + type: string + description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.dcim.console_server_ports.trace.yaml b/actions/get.dcim.console_server_ports.trace.yaml index f5d3c7c3..a1d9f7ea 100644 --- a/actions/get.dcim.console_server_ports.trace.yaml +++ b/actions/get.dcim.console_server_ports.trace.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." enabled: true entry_point: run.py diff --git a/actions/get.dcim.console_server_ports.yaml b/actions/get.dcim.console_server_ports.yaml index fb2b1620..e85ce138 100644 --- a/actions/get.dcim.console_server_ports.yaml +++ b/actions/get.dcim.console_server_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of console server port objects." enabled: true entry_point: run.py @@ -20,18 +20,94 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -43,31 +119,31 @@ parameters: description: "Connected" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -75,7 +151,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -83,75 +159,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -159,59 +243,67 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -219,27 +311,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -247,67 +339,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -315,19 +415,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" mark_connected: required: false @@ -339,15 +439,15 @@ parameters: description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -355,40 +455,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -401,73 +509,105 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" speed: required: false @@ -482,25 +622,89 @@ parameters: * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps" + speed__ic: + required: false + type: integer + description: "Speed contains (case-insensitive)" + speed__ie: + required: false + type: integer + description: "Speed exact match (case-insensitive)" + speed__iew: + required: false + type: integer + description: "Speed ends with (case-insensitive)" + speed__iregex: + required: false + type: integer + description: "Speed" + speed__isw: + required: false + type: integer + description: "Speed starts with (case-sensitive)" + speed__n: + required: false + type: integer + description: "Speed not equal to" + speed__nic: + required: false + type: integer + description: "Speed does not contain (case-insensitive)" + speed__nie: + required: false + type: integer + description: "Speed inverse exact match (case-insensitive)" + speed__niew: + required: false + type: integer + description: "Speed does not end with (case-insensitive)" + speed__nisw: + required: false + type: integer + description: "Speed does not start with (case-sensitive)" + speed__regex: + required: false + type: integer + description: "Speed" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Physical port type" type__empty: required: false @@ -508,59 +712,67 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Physical port type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Physical port type" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.device_bay_templates.yaml b/actions/get.dcim.device_bay_templates.yaml index cf7391a2..44b7c7b7 100644 --- a/actions/get.dcim.device_bay_templates.yaml +++ b/actions/get.dcim.device_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of device bay template objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,51 +62,63 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" + enabled: + required: false + type: boolean + description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -114,27 +126,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -142,67 +154,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -214,7 +234,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -222,40 +242,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -268,6 +296,10 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string diff --git a/actions/get.dcim.device_bays.yaml b/actions/get.dcim.device_bays.yaml index 6eaa618a..dda46338 100644 --- a/actions/get.dcim.device_bays.yaml +++ b/actions/get.dcim.device_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of device bay objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,75 +62,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -138,59 +146,71 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" + enabled: + required: false + type: boolean + description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -198,43 +218,43 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" installed_device: required: false - type: array + type: string description: "Installed device (name)" installed_device__n: required: false - type: array + type: string description: "Installed_device not equal to" installed_device_id: required: false - type: array + type: integer description: "Installed device (ID)" installed_device_id__n: required: false - type: array + type: integer description: "Installed_device_id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -242,67 +262,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -310,19 +338,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" modified_by_request: required: false @@ -330,7 +358,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -338,40 +366,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -380,109 +416,161 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.device_roles.yaml b/actions/get.dcim.device_roles.yaml index d6abcfbf..13be8564 100644 --- a/actions/get.dcim.device_roles.yaml +++ b/actions/get.dcim.device_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of device role objects." enabled: true entry_point: run.py @@ -22,23 +22,23 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ancestor: required: false - type: array + type: string description: "Ancestor" ancestor__n: required: false - type: array + type: string description: "Ancestor not equal to" ancestor_id: required: false - type: array + type: string description: "Ancestor_id" ancestor_id__n: required: false - type: array + type: string description: "Ancestor_id not equal to" color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -46,75 +46,83 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" config_template_id: required: false - type: array + type: integer description: "Config template (ID)" config_template_id__n: required: false - type: array + type: integer description: "Config_template_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -122,7 +130,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -130,43 +138,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -174,51 +190,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -230,7 +246,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -238,40 +254,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -280,21 +304,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent device role (slug)" parent__n: required: false - type: array + type: string description: "Parent not equal to" parent_id: required: false - type: array + type: integer description: "Parent device role (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" q: required: false @@ -302,7 +358,7 @@ parameters: description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -310,55 +366,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.device_types.yaml b/actions/get.dcim.device_types.yaml index 860b96da..e97bf43e 100644 --- a/actions/get.dcim.device_types.yaml +++ b/actions/get.dcim.device_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of device type objects." enabled: true entry_point: run.py @@ -33,9 +33,57 @@ parameters: * `top-to-bottom` - Top to bottom * `passive` - Passive * `mixed` - Mixed" + airflow__empty: + required: false + type: boolean + description: "Airflow is empty/null (boolean)" + airflow__ic: + required: false + type: string + description: "Airflow contains (case-insensitive)" + airflow__ie: + required: false + type: string + description: "Airflow exact match (case-insensitive)" + airflow__iew: + required: false + type: string + description: "Airflow ends with (case-insensitive)" + airflow__iregex: + required: false + type: string + description: "Airflow" + airflow__isw: + required: false + type: string + description: "Airflow starts with (case-sensitive)" + airflow__n: + required: false + type: string + description: "Airflow not equal to" + airflow__nic: + required: false + type: string + description: "Airflow does not contain (case-insensitive)" + airflow__nie: + required: false + type: string + description: "Airflow inverse exact match (case-insensitive)" + airflow__niew: + required: false + type: string + description: "Airflow does not end with (case-insensitive)" + airflow__nisw: + required: false + type: string + description: "Airflow does not start with (case-sensitive)" + airflow__regex: + required: false + type: string + description: "Airflow" console_port_template_count: required: false - type: array + type: integer description: "Console_port_template_count" console_port_template_count__empty: required: false @@ -43,23 +91,23 @@ parameters: description: "Console_port_template_count is empty/null (boolean)" console_port_template_count__gt: required: false - type: array + type: integer description: "Console_port_template_count greater than" console_port_template_count__gte: required: false - type: array + type: integer description: "Console_port_template_count greater than or equal to" console_port_template_count__lt: required: false - type: array + type: integer description: "Console_port_template_count less than" console_port_template_count__lte: required: false - type: array + type: integer description: "Console_port_template_count less than or equal to" console_port_template_count__n: required: false - type: array + type: integer description: "Console_port_template_count not equal to" console_ports: required: false @@ -67,7 +115,7 @@ parameters: description: "Has console ports" console_server_port_template_count: required: false - type: array + type: integer description: "Console_server_port_template_count" console_server_port_template_count__empty: required: false @@ -75,23 +123,23 @@ parameters: description: "Console_server_port_template_count is empty/null (boolean)" console_server_port_template_count__gt: required: false - type: array + type: integer description: "Console_server_port_template_count greater than" console_server_port_template_count__gte: required: false - type: array + type: integer description: "Console_server_port_template_count greater than or equal to" console_server_port_template_count__lt: required: false - type: array + type: integer description: "Console_server_port_template_count less than" console_server_port_template_count__lte: required: false - type: array + type: integer description: "Console_server_port_template_count less than or equal to" console_server_port_template_count__n: required: false - type: array + type: integer description: "Console_server_port_template_count not equal to" console_server_ports: required: false @@ -99,31 +147,31 @@ parameters: description: "Has console server ports" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -131,23 +179,23 @@ parameters: description: "Created_by_request" default_platform: required: false - type: array - description: "Default platform (slug)" + type: string + description: "Default_platform" default_platform__n: required: false - type: array + type: string description: "Default_platform not equal to" default_platform_id: required: false - type: array - description: "Default platform (ID)" + type: string + description: "Default_platform_id" default_platform_id__n: required: false - type: array + type: string description: "Default_platform_id not equal to" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -155,43 +203,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_bay_template_count: required: false - type: array + type: integer description: "Device_bay_template_count" device_bay_template_count__empty: required: false @@ -199,35 +255,63 @@ parameters: description: "Device_bay_template_count is empty/null (boolean)" device_bay_template_count__gt: required: false - type: array + type: integer description: "Device_bay_template_count greater than" device_bay_template_count__gte: required: false - type: array + type: integer description: "Device_bay_template_count greater than or equal to" device_bay_template_count__lt: required: false - type: array + type: integer description: "Device_bay_template_count less than" device_bay_template_count__lte: required: false - type: array + type: integer description: "Device_bay_template_count less than or equal to" device_bay_template_count__n: required: false - type: array + type: integer description: "Device_bay_template_count not equal to" device_bays: required: false type: boolean description: "Has device bays" + device_count: + required: false + type: integer + description: "Device_count" + device_count__empty: + required: false + type: boolean + description: "Device_count is empty/null (boolean)" + device_count__gt: + required: false + type: integer + description: "Device_count greater than" + device_count__gte: + required: false + type: integer + description: "Device_count greater than or equal to" + device_count__lt: + required: false + type: integer + description: "Device_count less than" + device_count__lte: + required: false + type: integer + description: "Device_count less than or equal to" + device_count__n: + required: false + type: integer + description: "Device_count not equal to" exclude_from_utilization: required: false type: boolean description: "Exclude_from_utilization" front_port_template_count: required: false - type: array + type: integer description: "Front_port_template_count" front_port_template_count__empty: required: false @@ -235,23 +319,23 @@ parameters: description: "Front_port_template_count is empty/null (boolean)" front_port_template_count__gt: required: false - type: array + type: integer description: "Front_port_template_count greater than" front_port_template_count__gte: required: false - type: array + type: integer description: "Front_port_template_count greater than or equal to" front_port_template_count__lt: required: false - type: array + type: integer description: "Front_port_template_count less than" front_port_template_count__lte: required: false - type: array + type: integer description: "Front_port_template_count less than or equal to" front_port_template_count__n: required: false - type: array + type: integer description: "Front_port_template_count not equal to" has_front_image: required: false @@ -263,7 +347,7 @@ parameters: description: "Has a rear image" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -271,27 +355,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_template_count: required: false - type: array + type: integer description: "Interface_template_count" interface_template_count__empty: required: false @@ -299,23 +383,23 @@ parameters: description: "Interface_template_count is empty/null (boolean)" interface_template_count__gt: required: false - type: array + type: integer description: "Interface_template_count greater than" interface_template_count__gte: required: false - type: array + type: integer description: "Interface_template_count greater than or equal to" interface_template_count__lt: required: false - type: array + type: integer description: "Interface_template_count less than" interface_template_count__lte: required: false - type: array + type: integer description: "Interface_template_count less than or equal to" interface_template_count__n: required: false - type: array + type: integer description: "Interface_template_count not equal to" interfaces: required: false @@ -323,7 +407,7 @@ parameters: description: "Has interfaces" inventory_item_template_count: required: false - type: array + type: integer description: "Inventory_item_template_count" inventory_item_template_count__empty: required: false @@ -331,23 +415,23 @@ parameters: description: "Inventory_item_template_count is empty/null (boolean)" inventory_item_template_count__gt: required: false - type: array + type: integer description: "Inventory_item_template_count greater than" inventory_item_template_count__gte: required: false - type: array + type: integer description: "Inventory_item_template_count greater than or equal to" inventory_item_template_count__lt: required: false - type: array + type: integer description: "Inventory_item_template_count less than" inventory_item_template_count__lte: required: false - type: array + type: integer description: "Inventory_item_template_count less than or equal to" inventory_item_template_count__n: required: false - type: array + type: integer description: "Inventory_item_template_count not equal to" inventory_items: required: false @@ -359,31 +443,31 @@ parameters: description: "Is_full_depth" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -391,23 +475,23 @@ parameters: description: "Number of results to return per page." manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" model: required: false - type: array + type: string description: "Model" model__empty: required: false @@ -415,47 +499,55 @@ parameters: description: "Model is empty/null (boolean)" model__ic: required: false - type: array + type: string description: "Model contains (case-insensitive)" model__ie: required: false - type: array + type: string description: "Model exact match (case-insensitive)" model__iew: required: false - type: array + type: string description: "Model ends with (case-insensitive)" + model__iregex: + required: false + type: string + description: "Model" model__isw: required: false - type: array + type: string description: "Model starts with (case-sensitive)" model__n: required: false - type: array + type: string description: "Model not equal to" model__nic: required: false - type: array + type: string description: "Model does not contain (case-insensitive)" model__nie: required: false - type: array + type: string description: "Model inverse exact match (case-insensitive)" model__niew: required: false - type: array + type: string description: "Model does not end with (case-insensitive)" model__nisw: required: false - type: array + type: string description: "Model does not start with (case-sensitive)" + model__regex: + required: false + type: string + description: "Model" modified_by_request: required: false type: string description: "Modified_by_request" module_bay_template_count: required: false - type: array + type: integer description: "Module_bay_template_count" module_bay_template_count__empty: required: false @@ -463,23 +555,23 @@ parameters: description: "Module_bay_template_count is empty/null (boolean)" module_bay_template_count__gt: required: false - type: array + type: integer description: "Module_bay_template_count greater than" module_bay_template_count__gte: required: false - type: array + type: integer description: "Module_bay_template_count greater than or equal to" module_bay_template_count__lt: required: false - type: array + type: integer description: "Module_bay_template_count less than" module_bay_template_count__lte: required: false - type: array + type: integer description: "Module_bay_template_count less than or equal to" module_bay_template_count__n: required: false - type: array + type: integer description: "Module_bay_template_count not equal to" module_bays: required: false @@ -493,9 +585,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" part_number: required: false - type: array + type: string description: "Part_number" part_number__empty: required: false @@ -503,47 +627,55 @@ parameters: description: "Part_number is empty/null (boolean)" part_number__ic: required: false - type: array + type: string description: "Part_number contains (case-insensitive)" part_number__ie: required: false - type: array + type: string description: "Part_number exact match (case-insensitive)" part_number__iew: required: false - type: array + type: string description: "Part_number ends with (case-insensitive)" + part_number__iregex: + required: false + type: string + description: "Part_number" part_number__isw: required: false - type: array + type: string description: "Part_number starts with (case-sensitive)" part_number__n: required: false - type: array + type: string description: "Part_number not equal to" part_number__nic: required: false - type: array + type: string description: "Part_number does not contain (case-insensitive)" part_number__nie: required: false - type: array + type: string description: "Part_number inverse exact match (case-insensitive)" part_number__niew: required: false - type: array + type: string description: "Part_number does not end with (case-insensitive)" part_number__nisw: required: false - type: array + type: string description: "Part_number does not start with (case-sensitive)" + part_number__regex: + required: false + type: string + description: "Part_number" pass_through_ports: required: false type: boolean description: "Has pass-through ports" power_outlet_template_count: required: false - type: array + type: integer description: "Power_outlet_template_count" power_outlet_template_count__empty: required: false @@ -551,23 +683,23 @@ parameters: description: "Power_outlet_template_count is empty/null (boolean)" power_outlet_template_count__gt: required: false - type: array + type: integer description: "Power_outlet_template_count greater than" power_outlet_template_count__gte: required: false - type: array + type: integer description: "Power_outlet_template_count greater than or equal to" power_outlet_template_count__lt: required: false - type: array + type: integer description: "Power_outlet_template_count less than" power_outlet_template_count__lte: required: false - type: array + type: integer description: "Power_outlet_template_count less than or equal to" power_outlet_template_count__n: required: false - type: array + type: integer description: "Power_outlet_template_count not equal to" power_outlets: required: false @@ -575,7 +707,7 @@ parameters: description: "Has power outlets" power_port_template_count: required: false - type: array + type: integer description: "Power_port_template_count" power_port_template_count__empty: required: false @@ -583,23 +715,23 @@ parameters: description: "Power_port_template_count is empty/null (boolean)" power_port_template_count__gt: required: false - type: array + type: integer description: "Power_port_template_count greater than" power_port_template_count__gte: required: false - type: array + type: integer description: "Power_port_template_count greater than or equal to" power_port_template_count__lt: required: false - type: array + type: integer description: "Power_port_template_count less than" power_port_template_count__lte: required: false - type: array + type: integer description: "Power_port_template_count less than or equal to" power_port_template_count__n: required: false - type: array + type: integer description: "Power_port_template_count not equal to" power_ports: required: false @@ -611,7 +743,7 @@ parameters: description: "Search" rear_port_template_count: required: false - type: array + type: integer description: "Rear_port_template_count" rear_port_template_count__empty: required: false @@ -619,27 +751,27 @@ parameters: description: "Rear_port_template_count is empty/null (boolean)" rear_port_template_count__gt: required: false - type: array + type: integer description: "Rear_port_template_count greater than" rear_port_template_count__gte: required: false - type: array + type: integer description: "Rear_port_template_count greater than or equal to" rear_port_template_count__lt: required: false - type: array + type: integer description: "Rear_port_template_count less than" rear_port_template_count__lte: required: false - type: array + type: integer description: "Rear_port_template_count less than or equal to" rear_port_template_count__n: required: false - type: array + type: integer description: "Rear_port_template_count not equal to" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -647,40 +779,52 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." subdevice_role: required: false type: string @@ -688,25 +832,73 @@ parameters: * `parent` - Parent * `child` - Child" + subdevice_role__empty: + required: false + type: boolean + description: "Subdevice_role is empty/null (boolean)" + subdevice_role__ic: + required: false + type: string + description: "Subdevice_role contains (case-insensitive)" + subdevice_role__ie: + required: false + type: string + description: "Subdevice_role exact match (case-insensitive)" + subdevice_role__iew: + required: false + type: string + description: "Subdevice_role ends with (case-insensitive)" + subdevice_role__iregex: + required: false + type: string + description: "Subdevice_role" + subdevice_role__isw: + required: false + type: string + description: "Subdevice_role starts with (case-sensitive)" + subdevice_role__n: + required: false + type: string + description: "Subdevice_role not equal to" + subdevice_role__nic: + required: false + type: string + description: "Subdevice_role does not contain (case-insensitive)" + subdevice_role__nie: + required: false + type: string + description: "Subdevice_role inverse exact match (case-insensitive)" + subdevice_role__niew: + required: false + type: string + description: "Subdevice_role does not end with (case-insensitive)" + subdevice_role__nisw: + required: false + type: string + description: "Subdevice_role does not start with (case-sensitive)" + subdevice_role__regex: + required: false + type: string + description: "Subdevice_role" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" u_height: required: false - type: array + type: integer description: "U_height" u_height__empty: required: false @@ -714,23 +906,23 @@ parameters: description: "U_height is empty/null (boolean)" u_height__gt: required: false - type: array + type: integer description: "U_height greater than" u_height__gte: required: false - type: array + type: integer description: "U_height greater than or equal to" u_height__lt: required: false - type: array + type: integer description: "U_height less than" u_height__lte: required: false - type: array + type: integer description: "U_height less than or equal to" u_height__n: required: false - type: array + type: integer description: "U_height not equal to" updated_by_request: required: false @@ -738,7 +930,7 @@ parameters: description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -746,23 +938,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" weight_unit: required: false @@ -771,6 +963,54 @@ parameters: * `g` - Grams * `lb` - Pounds * `oz` - Ounces" + weight_unit__empty: + required: false + type: boolean + description: "Weight_unit is empty/null (boolean)" + weight_unit__ic: + required: false + type: string + description: "Weight_unit contains (case-insensitive)" + weight_unit__ie: + required: false + type: string + description: "Weight_unit exact match (case-insensitive)" + weight_unit__iew: + required: false + type: string + description: "Weight_unit ends with (case-insensitive)" + weight_unit__iregex: + required: false + type: string + description: "Weight_unit" + weight_unit__isw: + required: false + type: string + description: "Weight_unit starts with (case-sensitive)" + weight_unit__n: + required: false + type: string + description: "Weight_unit not equal to" + weight_unit__nic: + required: false + type: string + description: "Weight_unit does not contain (case-insensitive)" + weight_unit__nie: + required: false + type: string + description: "Weight_unit inverse exact match (case-insensitive)" + weight_unit__niew: + required: false + type: string + description: "Weight_unit does not end with (case-insensitive)" + weight_unit__nisw: + required: false + type: string + description: "Weight_unit does not start with (case-sensitive)" + weight_unit__regex: + required: false + type: string + description: "Weight_unit" save_in_key_store: type: boolean default: false diff --git a/actions/get.dcim.devices.yaml b/actions/get.dcim.devices.yaml index 791afeaf..f8555988 100644 --- a/actions/get.dcim.devices.yaml +++ b/actions/get.dcim.devices.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of device objects." enabled: true entry_point: run.py @@ -33,9 +33,57 @@ parameters: * `top-to-bottom` - Top to bottom * `passive` - Passive * `mixed` - Mixed" + airflow__empty: + required: false + type: boolean + description: "Airflow is empty/null (boolean)" + airflow__ic: + required: false + type: string + description: "Airflow contains (case-insensitive)" + airflow__ie: + required: false + type: string + description: "Airflow exact match (case-insensitive)" + airflow__iew: + required: false + type: string + description: "Airflow ends with (case-insensitive)" + airflow__iregex: + required: false + type: string + description: "Airflow" + airflow__isw: + required: false + type: string + description: "Airflow starts with (case-sensitive)" + airflow__n: + required: false + type: string + description: "Airflow not equal to" + airflow__nic: + required: false + type: string + description: "Airflow does not contain (case-insensitive)" + airflow__nie: + required: false + type: string + description: "Airflow inverse exact match (case-insensitive)" + airflow__niew: + required: false + type: string + description: "Airflow does not end with (case-insensitive)" + airflow__nisw: + required: false + type: string + description: "Airflow does not start with (case-sensitive)" + airflow__regex: + required: false + type: string + description: "Airflow" asset_tag: required: false - type: array + type: string description: "Asset_tag" asset_tag__empty: required: false @@ -43,75 +91,83 @@ parameters: description: "Asset_tag is empty/null (boolean)" asset_tag__ic: required: false - type: array + type: string description: "Asset_tag contains (case-insensitive)" asset_tag__ie: required: false - type: array + type: string description: "Asset_tag exact match (case-insensitive)" asset_tag__iew: required: false - type: array + type: string description: "Asset_tag ends with (case-insensitive)" + asset_tag__iregex: + required: false + type: string + description: "Asset_tag" asset_tag__isw: required: false - type: array + type: string description: "Asset_tag starts with (case-sensitive)" asset_tag__n: required: false - type: array + type: string description: "Asset_tag not equal to" asset_tag__nic: required: false - type: array + type: string description: "Asset_tag does not contain (case-insensitive)" asset_tag__nie: required: false - type: array + type: string description: "Asset_tag inverse exact match (case-insensitive)" asset_tag__niew: required: false - type: array + type: string description: "Asset_tag does not end with (case-insensitive)" asset_tag__nisw: required: false - type: array + type: string description: "Asset_tag does not start with (case-sensitive)" + asset_tag__regex: + required: false + type: string + description: "Asset_tag" cluster_group: required: false - type: array + type: string description: "Cluster group (slug)" cluster_group__n: required: false - type: array + type: string description: "Cluster_group not equal to" cluster_group_id: required: false - type: array + type: integer description: "Cluster group (ID)" cluster_group_id__n: required: false - type: array + type: integer description: "Cluster_group_id not equal to" cluster_id: required: false - type: array + type: integer description: "VM cluster (ID)" cluster_id__n: required: false - type: array + type: integer description: "Cluster_id not equal to" config_template_id: required: false - type: array + type: integer description: "Config template (ID)" config_template_id__n: required: false - type: array + type: integer description: "Config_template_id not equal to" console_port_count: required: false - type: array + type: integer description: "Console_port_count" console_port_count__empty: required: false @@ -119,23 +175,23 @@ parameters: description: "Console_port_count is empty/null (boolean)" console_port_count__gt: required: false - type: array + type: integer description: "Console_port_count greater than" console_port_count__gte: required: false - type: array + type: integer description: "Console_port_count greater than or equal to" console_port_count__lt: required: false - type: array + type: integer description: "Console_port_count less than" console_port_count__lte: required: false - type: array + type: integer description: "Console_port_count less than or equal to" console_port_count__n: required: false - type: array + type: integer description: "Console_port_count not equal to" console_ports: required: false @@ -143,7 +199,7 @@ parameters: description: "Has console ports" console_server_port_count: required: false - type: array + type: integer description: "Console_server_port_count" console_server_port_count__empty: required: false @@ -151,23 +207,23 @@ parameters: description: "Console_server_port_count is empty/null (boolean)" console_server_port_count__gt: required: false - type: array + type: integer description: "Console_server_port_count greater than" console_server_port_count__gte: required: false - type: array + type: integer description: "Console_server_port_count greater than or equal to" console_server_port_count__lt: required: false - type: array + type: integer description: "Console_server_port_count less than" console_server_port_count__lte: required: false - type: array + type: integer description: "Console_server_port_count less than or equal to" console_server_port_count__n: required: false - type: array + type: integer description: "Console_server_port_count not equal to" console_server_ports: required: false @@ -175,55 +231,55 @@ parameters: description: "Has console server ports" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -231,7 +287,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -239,43 +295,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_bay_count: required: false - type: array + type: integer description: "Device_bay_count" device_bay_count__empty: required: false @@ -283,23 +347,23 @@ parameters: description: "Device_bay_count is empty/null (boolean)" device_bay_count__gt: required: false - type: array + type: integer description: "Device_bay_count greater than" device_bay_count__gte: required: false - type: array + type: integer description: "Device_bay_count greater than or equal to" device_bay_count__lt: required: false - type: array + type: integer description: "Device_bay_count less than" device_bay_count__lte: required: false - type: array + type: integer description: "Device_bay_count less than or equal to" device_bay_count__n: required: false - type: array + type: integer description: "Device_bay_count not equal to" device_bays: required: false @@ -307,28 +371,76 @@ parameters: description: "Has device bays" device_type: required: false - type: array + type: string description: "Device type (slug)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" face: required: false type: string description: "* `front` - Front * `rear` - Rear" + face__empty: + required: false + type: boolean + description: "Face is empty/null (boolean)" + face__ic: + required: false + type: string + description: "Face contains (case-insensitive)" + face__ie: + required: false + type: string + description: "Face exact match (case-insensitive)" + face__iew: + required: false + type: string + description: "Face ends with (case-insensitive)" + face__iregex: + required: false + type: string + description: "Face" + face__isw: + required: false + type: string + description: "Face starts with (case-sensitive)" + face__n: + required: false + type: string + description: "Face not equal to" + face__nic: + required: false + type: string + description: "Face does not contain (case-insensitive)" + face__nie: + required: false + type: string + description: "Face inverse exact match (case-insensitive)" + face__niew: + required: false + type: string + description: "Face does not end with (case-insensitive)" + face__nisw: + required: false + type: string + description: "Face does not start with (case-sensitive)" + face__regex: + required: false + type: string + description: "Face" front_port_count: required: false - type: array + type: integer description: "Front_port_count" front_port_count__empty: required: false @@ -336,23 +448,23 @@ parameters: description: "Front_port_count is empty/null (boolean)" front_port_count__gt: required: false - type: array + type: integer description: "Front_port_count greater than" front_port_count__gte: required: false - type: array + type: integer description: "Front_port_count greater than or equal to" front_port_count__lt: required: false - type: array + type: integer description: "Front_port_count less than" front_port_count__lte: required: false - type: array + type: integer description: "Front_port_count less than or equal to" front_port_count__n: required: false - type: array + type: integer description: "Front_port_count not equal to" has_oob_ip: required: false @@ -368,7 +480,7 @@ parameters: description: "Has virtual device context" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -376,27 +488,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_count: required: false - type: array + type: integer description: "Interface_count" interface_count__empty: required: false @@ -404,23 +516,23 @@ parameters: description: "Interface_count is empty/null (boolean)" interface_count__gt: required: false - type: array + type: integer description: "Interface_count greater than" interface_count__gte: required: false - type: array + type: integer description: "Interface_count greater than or equal to" interface_count__lt: required: false - type: array + type: integer description: "Interface_count less than" interface_count__lte: required: false - type: array + type: integer description: "Interface_count less than or equal to" interface_count__n: required: false - type: array + type: integer description: "Interface_count not equal to" interfaces: required: false @@ -428,7 +540,7 @@ parameters: description: "Has interfaces" inventory_item_count: required: false - type: array + type: integer description: "Inventory_item_count" inventory_item_count__empty: required: false @@ -436,23 +548,23 @@ parameters: description: "Inventory_item_count is empty/null (boolean)" inventory_item_count__gt: required: false - type: array + type: integer description: "Inventory_item_count greater than" inventory_item_count__gte: required: false - type: array + type: integer description: "Inventory_item_count greater than or equal to" inventory_item_count__lt: required: false - type: array + type: integer description: "Inventory_item_count less than" inventory_item_count__lte: required: false - type: array + type: integer description: "Inventory_item_count less than or equal to" inventory_item_count__n: required: false - type: array + type: integer description: "Inventory_item_count not equal to" is_full_depth: required: false @@ -460,35 +572,35 @@ parameters: description: "Is full depth" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" latitude: required: false - type: array + type: integer description: "Latitude" latitude__empty: required: false @@ -496,23 +608,23 @@ parameters: description: "Latitude is empty/null (boolean)" latitude__gt: required: false - type: array + type: integer description: "Latitude greater than" latitude__gte: required: false - type: array + type: integer description: "Latitude greater than or equal to" latitude__lt: required: false - type: array + type: integer description: "Latitude less than" latitude__lte: required: false - type: array + type: integer description: "Latitude less than or equal to" latitude__n: required: false - type: array + type: integer description: "Latitude not equal to" limit: required: false @@ -524,23 +636,23 @@ parameters: description: "Has local config context data" location: required: false - type: array + type: string description: "Location" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" longitude: required: false - type: array + type: integer description: "Longitude" longitude__empty: required: false @@ -548,87 +660,95 @@ parameters: description: "Longitude is empty/null (boolean)" longitude__gt: required: false - type: array + type: integer description: "Longitude greater than" longitude__gte: required: false - type: array + type: integer description: "Longitude greater than or equal to" longitude__lt: required: false - type: array + type: integer description: "Longitude less than" longitude__lte: required: false - type: array + type: integer description: "Longitude less than or equal to" longitude__n: required: false - type: array + type: integer description: "Longitude not equal to" mac_address: required: false - type: array + type: string description: "Mac_address" mac_address__ic: required: false - type: array + type: string description: "Mac_address contains (case-insensitive)" mac_address__ie: required: false - type: array + type: string description: "Mac_address exact match (case-insensitive)" mac_address__iew: required: false - type: array + type: string description: "Mac_address ends with (case-insensitive)" + mac_address__iregex: + required: false + type: string + description: "Mac_address" mac_address__isw: required: false - type: array + type: string description: "Mac_address starts with (case-sensitive)" mac_address__n: required: false - type: array + type: string description: "Mac_address not equal to" mac_address__nic: required: false - type: array + type: string description: "Mac_address does not contain (case-insensitive)" mac_address__nie: required: false - type: array + type: string description: "Mac_address inverse exact match (case-insensitive)" mac_address__niew: required: false - type: array + type: string description: "Mac_address does not end with (case-insensitive)" mac_address__nisw: required: false - type: array + type: string description: "Mac_address does not start with (case-sensitive)" + mac_address__regex: + required: false + type: string + description: "Mac_address" manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" model: required: false - type: array + type: string description: "Device model (slug)" model__n: required: false - type: array + type: string description: "Model not equal to" modified_by_request: required: false @@ -636,7 +756,7 @@ parameters: description: "Modified_by_request" module_bay_count: required: false - type: array + type: integer description: "Module_bay_count" module_bay_count__empty: required: false @@ -644,23 +764,23 @@ parameters: description: "Module_bay_count is empty/null (boolean)" module_bay_count__gt: required: false - type: array + type: integer description: "Module_bay_count greater than" module_bay_count__gte: required: false - type: array + type: integer description: "Module_bay_count greater than or equal to" module_bay_count__lt: required: false - type: array + type: integer description: "Module_bay_count less than" module_bay_count__lte: required: false - type: array + type: integer description: "Module_bay_count less than or equal to" module_bay_count__n: required: false - type: array + type: integer description: "Module_bay_count not equal to" module_bays: required: false @@ -668,7 +788,7 @@ parameters: description: "Has module bays" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -676,71 +796,111 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer description: "The initial index from which to return the results." oob_ip_id: required: false - type: array + type: integer description: "OOB IP (ID)" oob_ip_id__n: required: false - type: array + type: integer description: "Oob_ip_id not equal to" ordering: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent_bay_id: required: false - type: array + type: integer description: "Parent bay (ID)" parent_bay_id__n: required: false - type: array + type: integer description: "Parent_bay_id not equal to" parent_device_id: required: false - type: array + type: integer description: "Parent Device (ID)" parent_device_id__n: required: false - type: array + type: integer description: "Parent_device_id not equal to" pass_through_ports: required: false @@ -748,23 +908,23 @@ parameters: description: "Has pass-through ports" platform: required: false - type: array - description: "Platform (slug)" + type: string + description: "Platform" platform__n: required: false - type: array + type: string description: "Platform not equal to" platform_id: required: false - type: array - description: "Platform (ID)" + type: string + description: "Platform_id" platform_id__n: required: false - type: array + type: string description: "Platform_id not equal to" position: required: false - type: array + type: integer description: "Position" position__empty: required: false @@ -772,27 +932,27 @@ parameters: description: "Position is empty/null (boolean)" position__gt: required: false - type: array + type: integer description: "Position greater than" position__gte: required: false - type: array + type: integer description: "Position greater than or equal to" position__lt: required: false - type: array + type: integer description: "Position less than" position__lte: required: false - type: array + type: integer description: "Position less than or equal to" position__n: required: false - type: array + type: integer description: "Position not equal to" power_outlet_count: required: false - type: array + type: integer description: "Power_outlet_count" power_outlet_count__empty: required: false @@ -800,23 +960,23 @@ parameters: description: "Power_outlet_count is empty/null (boolean)" power_outlet_count__gt: required: false - type: array + type: integer description: "Power_outlet_count greater than" power_outlet_count__gte: required: false - type: array + type: integer description: "Power_outlet_count greater than or equal to" power_outlet_count__lt: required: false - type: array + type: integer description: "Power_outlet_count less than" power_outlet_count__lte: required: false - type: array + type: integer description: "Power_outlet_count less than or equal to" power_outlet_count__n: required: false - type: array + type: integer description: "Power_outlet_count not equal to" power_outlets: required: false @@ -824,7 +984,7 @@ parameters: description: "Has power outlets" power_port_count: required: false - type: array + type: integer description: "Power_port_count" power_port_count__empty: required: false @@ -832,23 +992,23 @@ parameters: description: "Power_port_count is empty/null (boolean)" power_port_count__gt: required: false - type: array + type: integer description: "Power_port_count greater than" power_port_count__gte: required: false - type: array + type: integer description: "Power_port_count greater than or equal to" power_port_count__lt: required: false - type: array + type: integer description: "Power_port_count less than" power_port_count__lte: required: false - type: array + type: integer description: "Power_port_count less than or equal to" power_port_count__n: required: false - type: array + type: integer description: "Power_port_count not equal to" power_ports: required: false @@ -856,35 +1016,35 @@ parameters: description: "Has power ports" primary_ip4: required: false - type: array + type: string description: "Primary IPv4 (address)" primary_ip4__n: required: false - type: array + type: string description: "Primary_ip4 not equal to" primary_ip4_id: required: false - type: array + type: integer description: "Primary IPv4 (ID)" primary_ip4_id__n: required: false - type: array + type: integer description: "Primary_ip4_id not equal to" primary_ip6: required: false - type: array + type: string description: "Primary IPv6 (address)" primary_ip6__n: required: false - type: array + type: string description: "Primary_ip6 not equal to" primary_ip6_id: required: false - type: array + type: integer description: "Primary IPv6 (ID)" primary_ip6_id__n: required: false - type: array + type: integer description: "Primary_ip6_id not equal to" q: required: false @@ -892,15 +1052,15 @@ parameters: description: "Search" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" rear_port_count: required: false - type: array + type: integer description: "Rear_port_count" rear_port_count__empty: required: false @@ -908,59 +1068,59 @@ parameters: description: "Rear_port_count is empty/null (boolean)" rear_port_count__gt: required: false - type: array + type: integer description: "Rear_port_count greater than" rear_port_count__gte: required: false - type: array + type: integer description: "Rear_port_count greater than or equal to" rear_port_count__lt: required: false - type: array + type: integer description: "Rear_port_count less than" rear_port_count__lte: required: false - type: array + type: integer description: "Rear_port_count less than or equal to" rear_port_count__n: required: false - type: array + type: integer description: "Rear_port_count not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" role: required: false - type: array + type: string description: "Role" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: string description: "Role_id" role_id__n: required: false - type: array + type: string description: "Role_id not equal to" serial: required: false - type: array + type: string description: "Serial" serial__empty: required: false @@ -968,75 +1128,87 @@ parameters: description: "Serial is empty/null (boolean)" serial__ic: required: false - type: array + type: string description: "Serial contains (case-insensitive)" serial__ie: required: false - type: array + type: string description: "Serial exact match (case-insensitive)" serial__iew: required: false - type: array + type: string description: "Serial ends with (case-insensitive)" + serial__iregex: + required: false + type: string + description: "Serial" serial__isw: required: false - type: array + type: string description: "Serial starts with (case-sensitive)" serial__n: required: false - type: array + type: string description: "Serial not equal to" serial__nic: required: false - type: array + type: string description: "Serial does not contain (case-insensitive)" serial__nie: required: false - type: array + type: string description: "Serial inverse exact match (case-insensitive)" serial__niew: required: false - type: array + type: string description: "Serial does not end with (case-insensitive)" serial__nisw: required: false - type: array + type: string description: "Serial does not start with (case-sensitive)" + serial__regex: + required: false + type: string + description: "Serial" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -1044,87 +1216,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -1132,7 +1312,7 @@ parameters: description: "Updated_by_request" vc_position: required: false - type: array + type: integer description: "Vc_position" vc_position__empty: required: false @@ -1140,27 +1320,27 @@ parameters: description: "Vc_position is empty/null (boolean)" vc_position__gt: required: false - type: array + type: integer description: "Vc_position greater than" vc_position__gte: required: false - type: array + type: integer description: "Vc_position greater than or equal to" vc_position__lt: required: false - type: array + type: integer description: "Vc_position less than" vc_position__lte: required: false - type: array + type: integer description: "Vc_position less than or equal to" vc_position__n: required: false - type: array + type: integer description: "Vc_position not equal to" vc_priority: required: false - type: array + type: integer description: "Vc_priority" vc_priority__empty: required: false @@ -1168,31 +1348,31 @@ parameters: description: "Vc_priority is empty/null (boolean)" vc_priority__gt: required: false - type: array + type: integer description: "Vc_priority greater than" vc_priority__gte: required: false - type: array + type: integer description: "Vc_priority greater than or equal to" vc_priority__lt: required: false - type: array + type: integer description: "Vc_priority less than" vc_priority__lte: required: false - type: array + type: integer description: "Vc_priority less than or equal to" vc_priority__n: required: false - type: array + type: integer description: "Vc_priority not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" virtual_chassis_member: required: false diff --git a/actions/get.dcim.front_port_templates.yaml b/actions/get.dcim.front_port_templates.yaml index 6bc6994b..3de0163a 100644 --- a/actions/get.dcim.front_port_templates.yaml +++ b/actions/get.dcim.front_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of front port template objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,51 +114,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -158,27 +174,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -186,67 +202,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -258,15 +282,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -274,40 +298,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -316,49 +348,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." - q: + positions: required: false - type: string - description: "Search" - rear_port_id: + type: integer + description: "Positions" + positions__empty: required: false - type: array - description: "Rear_port_id" - rear_port_id__n: + type: boolean + description: "Positions is empty/null (boolean)" + positions__gt: required: false - type: array - description: "Rear_port_id not equal to" - rear_port_position: + type: integer + description: "Positions greater than" + positions__gte: required: false - type: array - description: "Rear_port_position" - rear_port_position__empty: + type: integer + description: "Positions greater than or equal to" + positions__lt: required: false - type: boolean - description: "Rear_port_position is empty/null (boolean)" - rear_port_position__gt: + type: integer + description: "Positions less than" + positions__lte: required: false - type: array - description: "Rear_port_position greater than" - rear_port_position__gte: + type: integer + description: "Positions less than or equal to" + positions__n: + required: false + type: integer + description: "Positions not equal to" + q: required: false - type: array - description: "Rear_port_position greater than or equal to" - rear_port_position__lt: + type: string + description: "Search" + rear_port_id: required: false - type: array - description: "Rear_port_position less than" - rear_port_position__lte: + type: integer + description: "Rear port (ID)" + rear_port_id__n: required: false - type: array - description: "Rear_port_position less than or equal to" - rear_port_position__n: + type: integer + description: "Rear_port_id not equal to" + start: required: false - type: array - description: "Rear_port_position not equal to" + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -366,40 +402,48 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.dcim.front_ports.paths.yaml b/actions/get.dcim.front_ports.paths.yaml index a776c103..1fc17e0e 100644 --- a/actions/get.dcim.front_ports.paths.yaml +++ b/actions/get.dcim.front_ports.paths.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Return all CablePaths which traverse a given pass-through port." enabled: true entry_point: run.py diff --git a/actions/get.dcim.front_ports.yaml b/actions/get.dcim.front_ports.yaml index 7edfe15e..44771fd7 100644 --- a/actions/get.dcim.front_ports.yaml +++ b/actions/get.dcim.front_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of front port objects." enabled: true entry_point: run.py @@ -20,18 +20,94 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -39,7 +115,7 @@ parameters: description: "Cabled" color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -47,67 +123,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -115,7 +199,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -123,75 +207,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -199,59 +291,67 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -259,27 +359,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -287,67 +387,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -355,19 +463,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" mark_connected: required: false @@ -379,15 +487,15 @@ parameters: description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -395,40 +503,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -441,129 +557,181 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + positions: + required: false + type: integer + description: "Positions" + positions__empty: + required: false + type: boolean + description: "Positions is empty/null (boolean)" + positions__gt: + required: false + type: integer + description: "Positions greater than" + positions__gte: + required: false + type: integer + description: "Positions greater than or equal to" + positions__lt: + required: false + type: integer + description: "Positions less than" + positions__lte: + required: false + type: integer + description: "Positions less than or equal to" + positions__n: + required: false + type: integer + description: "Positions not equal to" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" rear_port_id: required: false - type: array - description: "Rear_port_id" + type: integer + description: "Rear port (ID)" rear_port_id__n: required: false - type: array + type: integer description: "Rear_port_id not equal to" - rear_port_position: - required: false - type: array - description: "Rear_port_position" - rear_port_position__empty: - required: false - type: boolean - description: "Rear_port_position is empty/null (boolean)" - rear_port_position__gt: - required: false - type: array - description: "Rear_port_position greater than" - rear_port_position__gte: - required: false - type: array - description: "Rear_port_position greater than or equal to" - rear_port_position__lt: - required: false - type: array - description: "Rear_port_position less than" - rear_port_position__lte: - required: false - type: array - description: "Rear_port_position less than or equal to" - rear_port_position__n: - required: false - type: array - description: "Rear_port_position not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -571,59 +739,67 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.interface_templates.yaml b/actions/get.dcim.interface_templates.yaml index 04bb1765..0cf7c566 100644 --- a/actions/get.dcim.interface_templates.yaml +++ b/actions/get.dcim.interface_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of interface template objects." enabled: true entry_point: run.py @@ -22,39 +22,39 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. bridge_id: required: false - type: array + type: integer description: "Bridge_id" bridge_id__n: required: false - type: array + type: integer description: "Bridge_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -62,7 +62,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -70,47 +70,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" enabled: required: false @@ -118,7 +126,7 @@ parameters: description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -126,27 +134,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -154,67 +162,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -230,15 +246,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -246,40 +262,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -290,7 +314,7 @@ parameters: description: "Which field to use when ordering the results." poe_mode: required: false - type: array + type: string description: "Poe_mode" poe_mode__empty: required: false @@ -298,43 +322,51 @@ parameters: description: "Poe_mode is empty/null (boolean)" poe_mode__ic: required: false - type: array + type: string description: "Poe_mode contains (case-insensitive)" poe_mode__ie: required: false - type: array + type: string description: "Poe_mode exact match (case-insensitive)" poe_mode__iew: required: false - type: array + type: string description: "Poe_mode ends with (case-insensitive)" + poe_mode__iregex: + required: false + type: string + description: "Poe_mode" poe_mode__isw: required: false - type: array + type: string description: "Poe_mode starts with (case-sensitive)" poe_mode__n: required: false - type: array + type: string description: "Poe_mode not equal to" poe_mode__nic: required: false - type: array + type: string description: "Poe_mode does not contain (case-insensitive)" poe_mode__nie: required: false - type: array + type: string description: "Poe_mode inverse exact match (case-insensitive)" poe_mode__niew: required: false - type: array + type: string description: "Poe_mode does not end with (case-insensitive)" poe_mode__nisw: required: false - type: array + type: string description: "Poe_mode does not start with (case-sensitive)" + poe_mode__regex: + required: false + type: string + description: "Poe_mode" poe_type: required: false - type: array + type: string description: "Poe_type" poe_type__empty: required: false @@ -342,47 +374,55 @@ parameters: description: "Poe_type is empty/null (boolean)" poe_type__ic: required: false - type: array + type: string description: "Poe_type contains (case-insensitive)" poe_type__ie: required: false - type: array + type: string description: "Poe_type exact match (case-insensitive)" poe_type__iew: required: false - type: array + type: string description: "Poe_type ends with (case-insensitive)" + poe_type__iregex: + required: false + type: string + description: "Poe_type" poe_type__isw: required: false - type: array + type: string description: "Poe_type starts with (case-sensitive)" poe_type__n: required: false - type: array + type: string description: "Poe_type not equal to" poe_type__nic: required: false - type: array + type: string description: "Poe_type does not contain (case-insensitive)" poe_type__nie: required: false - type: array + type: string description: "Poe_type inverse exact match (case-insensitive)" poe_type__niew: required: false - type: array + type: string description: "Poe_type does not end with (case-insensitive)" poe_type__nisw: required: false - type: array + type: string description: "Poe_type does not start with (case-sensitive)" + poe_type__regex: + required: false + type: string + description: "Poe_type" q: required: false type: string description: "Search" rf_role: required: false - type: array + type: string description: "Rf_role" rf_role__empty: required: false @@ -390,43 +430,55 @@ parameters: description: "Rf_role is empty/null (boolean)" rf_role__ic: required: false - type: array + type: string description: "Rf_role contains (case-insensitive)" rf_role__ie: required: false - type: array + type: string description: "Rf_role exact match (case-insensitive)" rf_role__iew: required: false - type: array + type: string description: "Rf_role ends with (case-insensitive)" + rf_role__iregex: + required: false + type: string + description: "Rf_role" rf_role__isw: required: false - type: array + type: string description: "Rf_role starts with (case-sensitive)" rf_role__n: required: false - type: array + type: string description: "Rf_role not equal to" rf_role__nic: required: false - type: array + type: string description: "Rf_role does not contain (case-insensitive)" rf_role__nie: required: false - type: array + type: string description: "Rf_role inverse exact match (case-insensitive)" rf_role__niew: required: false - type: array + type: string description: "Rf_role does not end with (case-insensitive)" rf_role__nisw: required: false - type: array + type: string description: "Rf_role does not start with (case-sensitive)" + rf_role__regex: + required: false + type: string + description: "Rf_role" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -434,40 +486,48 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.dcim.interfaces.trace.yaml b/actions/get.dcim.interfaces.trace.yaml index e70174df..892c5cf7 100644 --- a/actions/get.dcim.interfaces.trace.yaml +++ b/actions/get.dcim.interfaces.trace.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." enabled: true entry_point: run.py diff --git a/actions/get.dcim.interfaces.yaml b/actions/get.dcim.interfaces.yaml index a12d9103..ecc81d8f 100644 --- a/actions/get.dcim.interfaces.yaml +++ b/actions/get.dcim.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of interface objects." enabled: true entry_point: run.py @@ -22,24 +22,100 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. bridge_id: required: false - type: array + type: integer description: "Bridged interface (ID)" bridge_id__n: required: false - type: array + type: integer description: "Bridge_id not equal to" + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -51,31 +127,31 @@ parameters: description: "Connected" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -83,7 +159,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -91,75 +167,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -167,59 +251,67 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" duplex: required: false - type: array + type: string description: "Duplex" duplex__empty: required: false @@ -227,47 +319,55 @@ parameters: description: "Duplex is empty/null (boolean)" duplex__ic: required: false - type: array + type: string description: "Duplex contains (case-insensitive)" duplex__ie: required: false - type: array + type: string description: "Duplex exact match (case-insensitive)" duplex__iew: required: false - type: array + type: string description: "Duplex ends with (case-insensitive)" + duplex__iregex: + required: false + type: string + description: "Duplex" duplex__isw: required: false - type: array + type: string description: "Duplex starts with (case-sensitive)" duplex__n: required: false - type: array + type: string description: "Duplex not equal to" duplex__nic: required: false - type: array + type: string description: "Duplex does not contain (case-insensitive)" duplex__nie: required: false - type: array + type: string description: "Duplex inverse exact match (case-insensitive)" duplex__niew: required: false - type: array + type: string description: "Duplex does not end with (case-insensitive)" duplex__nisw: required: false - type: array + type: string description: "Duplex does not start with (case-sensitive)" + duplex__regex: + required: false + type: string + description: "Duplex" enabled: required: false type: boolean description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -275,23 +375,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" kind: required: false @@ -299,23 +399,23 @@ parameters: description: "Kind of interface" l2vpn: required: false - type: array + type: integer description: "L2VPN" l2vpn__n: required: false - type: array + type: integer description: "L2vpn not equal to" l2vpn_id: required: false - type: array + type: integer description: "L2VPN (ID)" l2vpn_id__n: required: false - type: array + type: integer description: "L2vpn_id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -323,75 +423,83 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" lag_id: required: false - type: array + type: integer description: "LAG interface (ID)" lag_id__n: required: false - type: array + type: integer description: "Lag_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -399,60 +507,68 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" mac_address: required: false - type: array + type: string description: "Mac_address" mac_address__ic: required: false - type: array + type: string description: "Mac_address contains (case-insensitive)" mac_address__ie: required: false - type: array + type: string description: "Mac_address exact match (case-insensitive)" mac_address__iew: required: false - type: array + type: string description: "Mac_address ends with (case-insensitive)" + mac_address__iregex: + required: false + type: string + description: "Mac_address" mac_address__isw: required: false - type: array + type: string description: "Mac_address starts with (case-sensitive)" mac_address__n: required: false - type: array + type: string description: "Mac_address not equal to" mac_address__nic: required: false - type: array + type: string description: "Mac_address does not contain (case-insensitive)" mac_address__nie: required: false - type: array + type: string description: "Mac_address inverse exact match (case-insensitive)" mac_address__niew: required: false - type: array + type: string description: "Mac_address does not end with (case-insensitive)" mac_address__nisw: required: false - type: array + type: string description: "Mac_address does not start with (case-sensitive)" + mac_address__regex: + required: false + type: string + description: "Mac_address" mark_connected: required: false type: boolean @@ -463,7 +579,7 @@ parameters: description: "Mgmt_only" mode: required: false - type: array + type: string description: "802.1Q Mode" mode__empty: required: false @@ -471,55 +587,63 @@ parameters: description: "Mode is empty/null (boolean)" mode__ic: required: false - type: array + type: string description: "Mode contains (case-insensitive)" mode__ie: required: false - type: array + type: string description: "Mode exact match (case-insensitive)" mode__iew: required: false - type: array + type: string description: "Mode ends with (case-insensitive)" + mode__iregex: + required: false + type: string + description: "802.1Q Mode" mode__isw: required: false - type: array + type: string description: "Mode starts with (case-sensitive)" mode__n: required: false - type: array + type: string description: "Mode not equal to" mode__nic: required: false - type: array + type: string description: "Mode does not contain (case-insensitive)" mode__nie: required: false - type: array + type: string description: "Mode inverse exact match (case-insensitive)" mode__niew: required: false - type: array + type: string description: "Mode does not end with (case-insensitive)" mode__nisw: required: false - type: array + type: string description: "Mode does not start with (case-sensitive)" + mode__regex: + required: false + type: string + description: "802.1Q Mode" modified_by_request: required: false type: string description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" mtu: required: false - type: array + type: integer description: "Mtu" mtu__empty: required: false @@ -527,27 +651,27 @@ parameters: description: "Mtu is empty/null (boolean)" mtu__gt: required: false - type: array + type: integer description: "Mtu greater than" mtu__gte: required: false - type: array + type: integer description: "Mtu greater than or equal to" mtu__lt: required: false - type: array + type: integer description: "Mtu less than" mtu__lte: required: false - type: array + type: integer description: "Mtu less than or equal to" mtu__n: required: false - type: array + type: integer description: "Mtu not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -555,40 +679,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -601,17 +733,49 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent_id: required: false - type: array + type: integer description: "Parent interface (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" poe_mode: required: false - type: array + type: string description: "Poe_mode" poe_mode__empty: required: false @@ -619,43 +783,51 @@ parameters: description: "Poe_mode is empty/null (boolean)" poe_mode__ic: required: false - type: array + type: string description: "Poe_mode contains (case-insensitive)" poe_mode__ie: required: false - type: array + type: string description: "Poe_mode exact match (case-insensitive)" poe_mode__iew: required: false - type: array + type: string description: "Poe_mode ends with (case-insensitive)" + poe_mode__iregex: + required: false + type: string + description: "Poe_mode" poe_mode__isw: required: false - type: array + type: string description: "Poe_mode starts with (case-sensitive)" poe_mode__n: required: false - type: array + type: string description: "Poe_mode not equal to" poe_mode__nic: required: false - type: array + type: string description: "Poe_mode does not contain (case-insensitive)" poe_mode__nie: required: false - type: array + type: string description: "Poe_mode inverse exact match (case-insensitive)" poe_mode__niew: required: false - type: array + type: string description: "Poe_mode does not end with (case-insensitive)" poe_mode__nisw: required: false - type: array + type: string description: "Poe_mode does not start with (case-sensitive)" + poe_mode__regex: + required: false + type: string + description: "Poe_mode" poe_type: required: false - type: array + type: string description: "Poe_type" poe_type__empty: required: false @@ -663,55 +835,63 @@ parameters: description: "Poe_type is empty/null (boolean)" poe_type__ic: required: false - type: array + type: string description: "Poe_type contains (case-insensitive)" poe_type__ie: required: false - type: array + type: string description: "Poe_type exact match (case-insensitive)" poe_type__iew: required: false - type: array + type: string description: "Poe_type ends with (case-insensitive)" + poe_type__iregex: + required: false + type: string + description: "Poe_type" poe_type__isw: required: false - type: array + type: string description: "Poe_type starts with (case-sensitive)" poe_type__n: required: false - type: array + type: string description: "Poe_type not equal to" poe_type__nic: required: false - type: array + type: string description: "Poe_type does not contain (case-insensitive)" poe_type__nie: required: false - type: array + type: string description: "Poe_type inverse exact match (case-insensitive)" poe_type__niew: required: false - type: array + type: string description: "Poe_type does not end with (case-insensitive)" poe_type__nisw: required: false - type: array + type: string description: "Poe_type does not start with (case-sensitive)" + poe_type__regex: + required: false + type: string + description: "Poe_type" primary_mac_address: required: false - type: array + type: string description: "Primary MAC address" primary_mac_address__n: required: false - type: array + type: string description: "Primary_mac_address not equal to" primary_mac_address_id: required: false - type: array + type: integer description: "Primary MAC address (ID)" primary_mac_address_id__n: required: false - type: array + type: integer description: "Primary_mac_address_id not equal to" q: required: false @@ -719,39 +899,39 @@ parameters: description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" rf_channel: required: false - type: array + type: string description: "Rf_channel" rf_channel__empty: required: false @@ -759,43 +939,51 @@ parameters: description: "Rf_channel is empty/null (boolean)" rf_channel__ic: required: false - type: array + type: string description: "Rf_channel contains (case-insensitive)" rf_channel__ie: required: false - type: array + type: string description: "Rf_channel exact match (case-insensitive)" rf_channel__iew: required: false - type: array + type: string description: "Rf_channel ends with (case-insensitive)" + rf_channel__iregex: + required: false + type: string + description: "Rf_channel" rf_channel__isw: required: false - type: array + type: string description: "Rf_channel starts with (case-sensitive)" rf_channel__n: required: false - type: array + type: string description: "Rf_channel not equal to" rf_channel__nic: required: false - type: array + type: string description: "Rf_channel does not contain (case-insensitive)" rf_channel__nie: required: false - type: array + type: string description: "Rf_channel inverse exact match (case-insensitive)" rf_channel__niew: required: false - type: array + type: string description: "Rf_channel does not end with (case-insensitive)" rf_channel__nisw: required: false - type: array + type: string description: "Rf_channel does not start with (case-sensitive)" + rf_channel__regex: + required: false + type: string + description: "Rf_channel" rf_channel_frequency: required: false - type: array + type: integer description: "Rf_channel_frequency" rf_channel_frequency__empty: required: false @@ -803,27 +991,27 @@ parameters: description: "Rf_channel_frequency is empty/null (boolean)" rf_channel_frequency__gt: required: false - type: array + type: integer description: "Rf_channel_frequency greater than" rf_channel_frequency__gte: required: false - type: array + type: integer description: "Rf_channel_frequency greater than or equal to" rf_channel_frequency__lt: required: false - type: array + type: integer description: "Rf_channel_frequency less than" rf_channel_frequency__lte: required: false - type: array + type: integer description: "Rf_channel_frequency less than or equal to" rf_channel_frequency__n: required: false - type: array + type: integer description: "Rf_channel_frequency not equal to" rf_channel_width: required: false - type: array + type: integer description: "Rf_channel_width" rf_channel_width__empty: required: false @@ -831,27 +1019,27 @@ parameters: description: "Rf_channel_width is empty/null (boolean)" rf_channel_width__gt: required: false - type: array + type: integer description: "Rf_channel_width greater than" rf_channel_width__gte: required: false - type: array + type: integer description: "Rf_channel_width greater than or equal to" rf_channel_width__lt: required: false - type: array + type: integer description: "Rf_channel_width less than" rf_channel_width__lte: required: false - type: array + type: integer description: "Rf_channel_width less than or equal to" rf_channel_width__n: required: false - type: array + type: integer description: "Rf_channel_width not equal to" rf_role: required: false - type: array + type: string description: "Rf_role" rf_role__empty: required: false @@ -859,119 +1047,147 @@ parameters: description: "Rf_role is empty/null (boolean)" rf_role__ic: required: false - type: array + type: string description: "Rf_role contains (case-insensitive)" rf_role__ie: required: false - type: array + type: string description: "Rf_role exact match (case-insensitive)" rf_role__iew: required: false - type: array + type: string description: "Rf_role ends with (case-insensitive)" + rf_role__iregex: + required: false + type: string + description: "Rf_role" rf_role__isw: required: false - type: array + type: string description: "Rf_role starts with (case-sensitive)" rf_role__n: required: false - type: array + type: string description: "Rf_role not equal to" rf_role__nic: required: false - type: array + type: string description: "Rf_role does not contain (case-insensitive)" rf_role__nie: required: false - type: array + type: string description: "Rf_role inverse exact match (case-insensitive)" rf_role__niew: required: false - type: array + type: string description: "Rf_role does not end with (case-insensitive)" rf_role__nisw: required: false - type: array + type: string description: "Rf_role does not start with (case-sensitive)" + rf_role__regex: + required: false + type: string + description: "Rf_role" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" speed: required: false - type: array + type: integer description: "Speed" speed__empty: required: false - type: array + type: integer description: "Speed is empty/null (boolean)" speed__gt: required: false - type: array + type: integer description: "Speed greater than" speed__gte: required: false - type: array + type: integer description: "Speed greater than or equal to" speed__lt: required: false - type: array + type: integer description: "Speed less than" speed__lte: required: false - type: array + type: integer description: "Speed less than or equal to" speed__n: required: false - type: array + type: integer description: "Speed not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" tx_power: required: false - type: array + type: integer description: "Tx_power" tx_power__empty: required: false @@ -979,27 +1195,27 @@ parameters: description: "Tx_power is empty/null (boolean)" tx_power__gt: required: false - type: array + type: integer description: "Tx_power greater than" tx_power__gte: required: false - type: array + type: integer description: "Tx_power greater than or equal to" tx_power__lt: required: false - type: array + type: integer description: "Tx_power less than" tx_power__lte: required: false - type: array + type: integer description: "Tx_power less than or equal to" tx_power__n: required: false - type: array + type: integer description: "Tx_power not equal to" type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -1007,107 +1223,123 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string description: "Updated_by_request" vdc: required: false - type: array + type: string description: "Virtual Device Context" vdc__n: required: false - type: array + type: string description: "Vdc not equal to" vdc_id: required: false - type: array + type: integer description: "Virtual Device Context" vdc_id__n: required: false - type: array + type: integer description: "Vdc_id not equal to" vdc_identifier: required: false - type: array + type: integer description: "Virtual Device Context (Identifier)" vdc_identifier__n: required: false - type: array + type: integer description: "Vdc_identifier not equal to" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" virtual_chassis_member: required: false - type: array + type: string description: "Virtual_chassis_member" virtual_chassis_member_id: required: false - type: array + type: integer description: "Virtual_chassis_member_id" + virtual_chassis_member_or_master: + required: false + type: string + description: "Virtual_chassis_member_or_master" + virtual_chassis_member_or_master_id: + required: false + type: integer + description: "Virtual_chassis_member_or_master_id" virtual_circuit_id: required: false - type: array + type: integer description: "Virtual circuit (ID)" virtual_circuit_id__n: required: false - type: array + type: integer description: "Virtual_circuit_id not equal to" virtual_circuit_termination_id: required: false - type: array + type: integer description: "Virtual circuit termination (ID)" virtual_circuit_termination_id__n: required: false - type: array + type: integer description: "Virtual_circuit_termination_id not equal to" vlan: required: false @@ -1119,92 +1351,100 @@ parameters: description: "Assigned VLAN" vlan_translation_policy: required: false - type: array + type: string description: "VLAN Translation Policy" vlan_translation_policy__n: required: false - type: array + type: string description: "Vlan_translation_policy not equal to" vlan_translation_policy_id: required: false - type: array + type: integer description: "VLAN Translation Policy (ID)" vlan_translation_policy_id__n: required: false - type: array + type: integer description: "Vlan_translation_policy_id not equal to" vrf: required: false - type: array + type: string description: "VRF (RD)" vrf__n: required: false - type: array + type: string description: "Vrf not equal to" vrf_id: required: false - type: array + type: integer description: "VRF" vrf_id__n: required: false - type: array + type: integer description: "Vrf_id not equal to" wireless_lan_id: required: false - type: array + type: integer description: "Wireless LAN" wireless_lan_id__n: required: false - type: array + type: integer description: "Wireless_lan_id not equal to" wireless_link_id: required: false - type: array + type: integer description: "Wireless link" wireless_link_id__n: required: false - type: array + type: integer description: "Wireless_link_id not equal to" wwn: required: false - type: array + type: string description: "Wwn" wwn__ic: required: false - type: array + type: string description: "Wwn contains (case-insensitive)" wwn__ie: required: false - type: array + type: string description: "Wwn exact match (case-insensitive)" wwn__iew: required: false - type: array + type: string description: "Wwn ends with (case-insensitive)" + wwn__iregex: + required: false + type: string + description: "Wwn" wwn__isw: required: false - type: array + type: string description: "Wwn starts with (case-sensitive)" wwn__n: required: false - type: array + type: string description: "Wwn not equal to" wwn__nic: required: false - type: array + type: string description: "Wwn does not contain (case-insensitive)" wwn__nie: required: false - type: array + type: string description: "Wwn inverse exact match (case-insensitive)" wwn__niew: required: false - type: array + type: string description: "Wwn does not end with (case-insensitive)" wwn__nisw: required: false - type: array + type: string description: "Wwn does not start with (case-sensitive)" + wwn__regex: + required: false + type: string + description: "Wwn" save_in_key_store: type: boolean default: false diff --git a/actions/get.dcim.inventory_item_roles.yaml b/actions/get.dcim.inventory_item_roles.yaml index 21ef6f94..0d9da9f7 100644 --- a/actions/get.dcim.inventory_item_roles.yaml +++ b/actions/get.dcim.inventory_item_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of inventory item role objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,51 +166,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -206,7 +222,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -214,40 +230,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -256,13 +280,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -270,55 +326,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.inventory_item_templates.yaml b/actions/get.dcim.inventory_item_templates.yaml index b22a903b..fc680468 100644 --- a/actions/get.dcim.inventory_item_templates.yaml +++ b/actions/get.dcim.inventory_item_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of inventory item template objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. component_id: required: false - type: array + type: integer description: "Component_id" component_id__empty: required: false - type: array + type: integer description: "Component_id is empty/null (boolean)" component_id__gt: required: false - type: array + type: integer description: "Component_id greater than" component_id__gte: required: false - type: array + type: integer description: "Component_id greater than or equal to" component_id__lt: required: false - type: array + type: integer description: "Component_id less than" component_id__lte: required: false - type: array + type: integer description: "Component_id less than or equal to" component_id__n: required: false - type: array + type: integer description: "Component_id not equal to" component_type: required: false @@ -58,31 +58,31 @@ parameters: description: "Component_type not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -90,7 +90,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -98,51 +98,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,27 +158,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -178,67 +186,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -246,19 +262,19 @@ parameters: description: "Number of results to return per page." manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" modified_by_request: required: false @@ -266,7 +282,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -274,40 +290,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -318,15 +342,15 @@ parameters: description: "Which field to use when ordering the results." parent_id: required: false - type: array + type: integer description: "Parent inventory item (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" part_id: required: false - type: array + type: string description: "Part_id" part_id__empty: required: false @@ -334,60 +358,72 @@ parameters: description: "Part_id is empty/null (boolean)" part_id__ic: required: false - type: array + type: string description: "Part_id contains (case-insensitive)" part_id__ie: required: false - type: array + type: string description: "Part_id exact match (case-insensitive)" part_id__iew: required: false - type: array + type: string description: "Part_id ends with (case-insensitive)" + part_id__iregex: + required: false + type: string + description: "Part_id" part_id__isw: required: false - type: array + type: string description: "Part_id starts with (case-sensitive)" part_id__n: required: false - type: array + type: string description: "Part_id not equal to" part_id__nic: required: false - type: array + type: string description: "Part_id does not contain (case-insensitive)" part_id__nie: required: false - type: array + type: string description: "Part_id inverse exact match (case-insensitive)" part_id__niew: required: false - type: array + type: string description: "Part_id does not end with (case-insensitive)" part_id__nisw: required: false - type: array + type: string description: "Part_id does not start with (case-sensitive)" + part_id__regex: + required: false + type: string + description: "Part_id" q: required: false type: string description: "Search" role: required: false - type: array + type: string description: "Role (slug)" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: integer description: "Role (ID)" role_id__n: required: false - type: array + type: integer description: "Role_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string diff --git a/actions/get.dcim.inventory_items.yaml b/actions/get.dcim.inventory_items.yaml index 43d66f67..20f9df54 100644 --- a/actions/get.dcim.inventory_items.yaml +++ b/actions/get.dcim.inventory_items.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of inventory item objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. asset_tag: required: false - type: array + type: string description: "Asset_tag" asset_tag__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Asset_tag is empty/null (boolean)" asset_tag__ic: required: false - type: array + type: string description: "Asset_tag contains (case-insensitive)" asset_tag__ie: required: false - type: array + type: string description: "Asset_tag exact match (case-insensitive)" asset_tag__iew: required: false - type: array + type: string description: "Asset_tag ends with (case-insensitive)" + asset_tag__iregex: + required: false + type: string + description: "Asset_tag" asset_tag__isw: required: false - type: array + type: string description: "Asset_tag starts with (case-sensitive)" asset_tag__n: required: false - type: array + type: string description: "Asset_tag not equal to" asset_tag__nic: required: false - type: array + type: string description: "Asset_tag does not contain (case-insensitive)" asset_tag__nie: required: false - type: array + type: string description: "Asset_tag inverse exact match (case-insensitive)" asset_tag__niew: required: false - type: array + type: string description: "Asset_tag does not end with (case-insensitive)" asset_tag__nisw: required: false - type: array + type: string description: "Asset_tag does not start with (case-sensitive)" + asset_tag__regex: + required: false + type: string + description: "Asset_tag" component_id: required: false - type: array + type: integer description: "Component_id" component_id__empty: required: false - type: array + type: integer description: "Component_id is empty/null (boolean)" component_id__gt: required: false - type: array + type: integer description: "Component_id greater than" component_id__gte: required: false - type: array + type: integer description: "Component_id greater than or equal to" component_id__lt: required: false - type: array + type: integer description: "Component_id less than" component_id__lte: required: false - type: array + type: integer description: "Component_id less than or equal to" component_id__n: required: false - type: array + type: integer description: "Component_id not equal to" component_type: required: false @@ -102,31 +110,31 @@ parameters: description: "Component_type not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -134,7 +142,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -142,75 +150,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -218,55 +234,63 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" discovered: required: false @@ -274,7 +298,7 @@ parameters: description: "Discovered" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -282,27 +306,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -310,67 +334,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -378,35 +410,35 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" modified_by_request: required: false @@ -414,7 +446,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -422,40 +454,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -464,17 +504,49 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent_id: required: false - type: array + type: integer description: "Parent inventory item (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" part_id: required: false - type: array + type: string description: "Part_id" part_id__empty: required: false @@ -482,95 +554,103 @@ parameters: description: "Part_id is empty/null (boolean)" part_id__ic: required: false - type: array + type: string description: "Part_id contains (case-insensitive)" part_id__ie: required: false - type: array + type: string description: "Part_id exact match (case-insensitive)" part_id__iew: required: false - type: array + type: string description: "Part_id ends with (case-insensitive)" + part_id__iregex: + required: false + type: string + description: "Part_id" part_id__isw: required: false - type: array + type: string description: "Part_id starts with (case-sensitive)" part_id__n: required: false - type: array + type: string description: "Part_id not equal to" part_id__nic: required: false - type: array + type: string description: "Part_id does not contain (case-insensitive)" part_id__nie: required: false - type: array + type: string description: "Part_id inverse exact match (case-insensitive)" part_id__niew: required: false - type: array + type: string description: "Part_id does not end with (case-insensitive)" part_id__nisw: required: false - type: array + type: string description: "Part_id does not start with (case-sensitive)" + part_id__regex: + required: false + type: string + description: "Part_id" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" role: required: false - type: array + type: string description: "Role (slug)" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: integer description: "Role (ID)" role_id__n: required: false - type: array + type: integer description: "Role_id not equal to" serial: required: false - type: array + type: string description: "Serial" serial__empty: required: false @@ -578,75 +658,87 @@ parameters: description: "Serial is empty/null (boolean)" serial__ic: required: false - type: array + type: string description: "Serial contains (case-insensitive)" serial__ie: required: false - type: array + type: string description: "Serial exact match (case-insensitive)" serial__iew: required: false - type: array + type: string description: "Serial ends with (case-insensitive)" + serial__iregex: + required: false + type: string + description: "Serial" serial__isw: required: false - type: array + type: string description: "Serial starts with (case-sensitive)" serial__n: required: false - type: array + type: string description: "Serial not equal to" serial__nic: required: false - type: array + type: string description: "Serial does not contain (case-insensitive)" serial__nie: required: false - type: array + type: string description: "Serial inverse exact match (case-insensitive)" serial__niew: required: false - type: array + type: string description: "Serial does not end with (case-insensitive)" serial__nisw: required: false - type: array + type: string description: "Serial does not start with (case-sensitive)" + serial__regex: + required: false + type: string + description: "Serial" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -654,75 +746,99 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.locations.yaml b/actions/get.dcim.locations.yaml index 4b374cb7..f2179901 100644 --- a/actions/get.dcim.locations.yaml +++ b/actions/get.dcim.locations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of location objects." enabled: true entry_point: run.py @@ -22,71 +22,71 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ancestor: required: false - type: array + type: string description: "Ancestor" ancestor__n: required: false - type: array + type: string description: "Ancestor not equal to" ancestor_id: required: false - type: array + type: string description: "Ancestor_id" ancestor_id__n: required: false - type: array + type: string description: "Ancestor_id not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -94,7 +94,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -102,43 +102,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" facility: required: false - type: array + type: string description: "Facility" facility__empty: required: false @@ -146,43 +154,51 @@ parameters: description: "Facility is empty/null (boolean)" facility__ic: required: false - type: array + type: string description: "Facility contains (case-insensitive)" facility__ie: required: false - type: array + type: string description: "Facility exact match (case-insensitive)" facility__iew: required: false - type: array + type: string description: "Facility ends with (case-insensitive)" + facility__iregex: + required: false + type: string + description: "Facility" facility__isw: required: false - type: array + type: string description: "Facility starts with (case-sensitive)" facility__n: required: false - type: array + type: string description: "Facility not equal to" facility__nic: required: false - type: array + type: string description: "Facility does not contain (case-insensitive)" facility__nie: required: false - type: array + type: string description: "Facility inverse exact match (case-insensitive)" facility__niew: required: false - type: array + type: string description: "Facility does not end with (case-insensitive)" facility__nisw: required: false - type: array + type: string description: "Facility does not start with (case-sensitive)" + facility__regex: + required: false + type: string + description: "Facility" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -190,51 +206,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -246,7 +262,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -254,40 +270,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -296,21 +320,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent location (slug)" parent__n: required: false - type: array + type: string description: "Parent not equal to" parent_id: required: false - type: array + type: integer description: "Parent location (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" q: required: false @@ -318,55 +374,55 @@ parameters: description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -374,43 +430,55 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -418,87 +486,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.mac_addresses.yaml b/actions/get.dcim.mac_addresses.yaml index 94d70f7f..8f8e3690 100644 --- a/actions/get.dcim.mac_addresses.yaml +++ b/actions/get.dcim.mac_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of MAC address objects." enabled: true entry_point: run.py @@ -20,9 +20,13 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + assigned: + required: false + type: boolean + description: "Is assigned" assigned_object_id: required: false - type: array + type: integer description: "Assigned_object_id" assigned_object_id__empty: required: false @@ -30,59 +34,59 @@ parameters: description: "Assigned_object_id is empty/null (boolean)" assigned_object_id__gt: required: false - type: array + type: integer description: "Assigned_object_id greater than" assigned_object_id__gte: required: false - type: array + type: integer description: "Assigned_object_id greater than or equal to" assigned_object_id__lt: required: false - type: array + type: integer description: "Assigned_object_id less than" assigned_object_id__lte: required: false - type: array + type: integer description: "Assigned_object_id less than or equal to" assigned_object_id__n: required: false - type: array + type: integer description: "Assigned_object_id not equal to" assigned_object_type: required: false - type: integer + type: string description: "Assigned_object_type" assigned_object_type__n: required: false - type: integer + type: string description: "Assigned_object_type not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -90,7 +94,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -98,51 +102,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device" device_id: required: false - type: array + type: integer description: "Device_id" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,67 +162,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface: required: false - type: array + type: string description: "Interface (name)" interface__n: required: false - type: array + type: string description: "Interface not equal to" interface_id: required: false - type: array + type: integer description: "Interface (ID)" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -218,44 +230,52 @@ parameters: description: "Number of results to return per page." mac_address: required: false - type: array + type: string description: "Mac_address" mac_address__ic: required: false - type: array + type: string description: "Mac_address contains (case-insensitive)" mac_address__ie: required: false - type: array + type: string description: "Mac_address exact match (case-insensitive)" mac_address__iew: required: false - type: array + type: string description: "Mac_address ends with (case-insensitive)" + mac_address__iregex: + required: false + type: string + description: "Mac_address" mac_address__isw: required: false - type: array + type: string description: "Mac_address starts with (case-sensitive)" mac_address__n: required: false - type: array + type: string description: "Mac_address not equal to" mac_address__nic: required: false - type: array + type: string description: "Mac_address does not contain (case-insensitive)" mac_address__nie: required: false - type: array + type: string description: "Mac_address inverse exact match (case-insensitive)" mac_address__niew: required: false - type: array + type: string description: "Mac_address does not end with (case-insensitive)" mac_address__nisw: required: false - type: array + type: string description: "Mac_address does not start with (case-sensitive)" + mac_address__regex: + required: false + type: string + description: "Mac_address" modified_by_request: required: false type: string @@ -268,25 +288,65 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + primary: + required: false + type: boolean + description: "Is primary" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -294,27 +354,27 @@ parameters: description: "Updated_by_request" virtual_machine: required: false - type: array + type: string description: "Virtual_machine" virtual_machine_id: required: false - type: array + type: integer description: "Virtual_machine_id" vminterface: required: false - type: array + type: string description: "VM interface (name)" vminterface__n: required: false - type: array + type: string description: "Vminterface not equal to" vminterface_id: required: false - type: array + type: integer description: "VM interface (ID)" vminterface_id__n: required: false - type: array + type: integer description: "Vminterface_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.manufacturers.yaml b/actions/get.dcim.manufacturers.yaml index cf6a4db8..040c6cfd 100644 --- a/actions/get.dcim.manufacturers.yaml +++ b/actions/get.dcim.manufacturers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of manufacturer objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,43 +86,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -130,51 +138,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -186,7 +194,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -194,40 +202,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -236,13 +252,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -250,55 +298,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.module_bay_templates.yaml b/actions/get.dcim.module_bay_templates.yaml index 514064e8..13875e15 100644 --- a/actions/get.dcim.module_bay_templates.yaml +++ b/actions/get.dcim.module_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of module bay template objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,51 +62,63 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" + enabled: + required: false + type: boolean + description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -114,27 +126,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -142,67 +154,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -214,15 +234,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -230,40 +250,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -274,7 +302,7 @@ parameters: description: "Which field to use when ordering the results." position: required: false - type: array + type: string description: "Position" position__empty: required: false @@ -282,44 +310,56 @@ parameters: description: "Position is empty/null (boolean)" position__ic: required: false - type: array + type: string description: "Position contains (case-insensitive)" position__ie: required: false - type: array + type: string description: "Position exact match (case-insensitive)" position__iew: required: false - type: array + type: string description: "Position ends with (case-insensitive)" + position__iregex: + required: false + type: string + description: "Position" position__isw: required: false - type: array + type: string description: "Position starts with (case-sensitive)" position__n: required: false - type: array + type: string description: "Position not equal to" position__nic: required: false - type: array + type: string description: "Position does not contain (case-insensitive)" position__nie: required: false - type: array + type: string description: "Position inverse exact match (case-insensitive)" position__niew: required: false - type: array + type: string description: "Position does not end with (case-insensitive)" position__nisw: required: false - type: array + type: string description: "Position does not start with (case-sensitive)" + position__regex: + required: false + type: string + description: "Position" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string diff --git a/actions/get.dcim.module_bays.yaml b/actions/get.dcim.module_bays.yaml index 483e9c3c..482bfffc 100644 --- a/actions/get.dcim.module_bays.yaml +++ b/actions/get.dcim.module_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of module bay objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,75 +62,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -138,59 +146,71 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" + enabled: + required: false + type: boolean + description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -198,35 +218,35 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" installed_module_id: required: false - type: array + type: integer description: "Installed module (ID)" installed_module_id__n: required: false - type: array + type: integer description: "Installed_module_id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -234,67 +254,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -302,19 +330,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" modified_by_request: required: false @@ -322,15 +350,15 @@ parameters: description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -338,40 +366,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -380,17 +416,49 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent_id: required: false - type: array + type: integer description: "Parent module bay (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" position: required: false - type: array + type: string description: "Position" position__empty: required: false @@ -398,143 +466,171 @@ parameters: description: "Position is empty/null (boolean)" position__ic: required: false - type: array + type: string description: "Position contains (case-insensitive)" position__ie: required: false - type: array + type: string description: "Position exact match (case-insensitive)" position__iew: required: false - type: array + type: string description: "Position ends with (case-insensitive)" + position__iregex: + required: false + type: string + description: "Position" position__isw: required: false - type: array + type: string description: "Position starts with (case-sensitive)" position__n: required: false - type: array + type: string description: "Position not equal to" position__nic: required: false - type: array + type: string description: "Position does not contain (case-insensitive)" position__nie: required: false - type: array + type: string description: "Position inverse exact match (case-insensitive)" position__niew: required: false - type: array + type: string description: "Position does not end with (case-insensitive)" position__nisw: required: false - type: array + type: string description: "Position does not start with (case-sensitive)" + position__regex: + required: false + type: string + description: "Position" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.module_type_profiles.yaml b/actions/get.dcim.module_type_profiles.yaml index a519429d..a1ea8b4b 100644 --- a/actions/get.dcim.module_type_profiles.yaml +++ b/actions/get.dcim.module_type_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of module type profile objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,25 +228,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.module_types.yaml b/actions/get.dcim.module_types.yaml index 8ec8b53b..f4952186 100644 --- a/actions/get.dcim.module_types.yaml +++ b/actions/get.dcim.module_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of module type objects." enabled: true entry_point: run.py @@ -29,6 +29,54 @@ parameters: * `right-to-left` - Right to left * `side-to-rear` - Side to rear * `passive` - Passive" + airflow__empty: + required: false + type: boolean + description: "Airflow is empty/null (boolean)" + airflow__ic: + required: false + type: string + description: "Airflow contains (case-insensitive)" + airflow__ie: + required: false + type: string + description: "Airflow exact match (case-insensitive)" + airflow__iew: + required: false + type: string + description: "Airflow ends with (case-insensitive)" + airflow__iregex: + required: false + type: string + description: "Airflow" + airflow__isw: + required: false + type: string + description: "Airflow starts with (case-sensitive)" + airflow__n: + required: false + type: string + description: "Airflow not equal to" + airflow__nic: + required: false + type: string + description: "Airflow does not contain (case-insensitive)" + airflow__nie: + required: false + type: string + description: "Airflow inverse exact match (case-insensitive)" + airflow__niew: + required: false + type: string + description: "Airflow does not end with (case-insensitive)" + airflow__nisw: + required: false + type: string + description: "Airflow does not start with (case-sensitive)" + airflow__regex: + required: false + type: string + description: "Airflow" console_ports: required: false type: boolean @@ -39,31 +87,31 @@ parameters: description: "Has console server ports" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -71,7 +119,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -79,43 +127,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -123,23 +179,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interfaces: required: false @@ -147,31 +203,31 @@ parameters: description: "Has interfaces" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -179,23 +235,23 @@ parameters: description: "Number of results to return per page." manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" model: required: false - type: array + type: string description: "Model" model__empty: required: false @@ -203,44 +259,80 @@ parameters: description: "Model is empty/null (boolean)" model__ic: required: false - type: array + type: string description: "Model contains (case-insensitive)" model__ie: required: false - type: array + type: string description: "Model exact match (case-insensitive)" model__iew: required: false - type: array + type: string description: "Model ends with (case-insensitive)" + model__iregex: + required: false + type: string + description: "Model" model__isw: required: false - type: array + type: string description: "Model starts with (case-sensitive)" model__n: required: false - type: array + type: string description: "Model not equal to" model__nic: required: false - type: array + type: string description: "Model does not contain (case-insensitive)" model__nie: required: false - type: array + type: string description: "Model inverse exact match (case-insensitive)" model__niew: required: false - type: array + type: string description: "Model does not end with (case-insensitive)" model__nisw: required: false - type: array + type: string description: "Model does not start with (case-sensitive)" + model__regex: + required: false + type: string + description: "Model" modified_by_request: required: false type: string description: "Modified_by_request" + module_count: + required: false + type: integer + description: "Module_count" + module_count__empty: + required: false + type: boolean + description: "Module_count is empty/null (boolean)" + module_count__gt: + required: false + type: integer + description: "Module_count greater than" + module_count__gte: + required: false + type: integer + description: "Module_count greater than or equal to" + module_count__lt: + required: false + type: integer + description: "Module_count less than" + module_count__lte: + required: false + type: integer + description: "Module_count less than or equal to" + module_count__n: + required: false + type: integer + description: "Module_count not equal to" offset: required: false type: integer @@ -249,9 +341,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" part_number: required: false - type: array + type: string description: "Part_number" part_number__empty: required: false @@ -259,40 +383,48 @@ parameters: description: "Part_number is empty/null (boolean)" part_number__ic: required: false - type: array + type: string description: "Part_number contains (case-insensitive)" part_number__ie: required: false - type: array + type: string description: "Part_number exact match (case-insensitive)" part_number__iew: required: false - type: array + type: string description: "Part_number ends with (case-insensitive)" + part_number__iregex: + required: false + type: string + description: "Part_number" part_number__isw: required: false - type: array + type: string description: "Part_number starts with (case-sensitive)" part_number__n: required: false - type: array + type: string description: "Part_number not equal to" part_number__nic: required: false - type: array + type: string description: "Part_number does not contain (case-insensitive)" part_number__nie: required: false - type: array + type: string description: "Part_number inverse exact match (case-insensitive)" part_number__niew: required: false - type: array + type: string description: "Part_number does not end with (case-insensitive)" part_number__nisw: required: false - type: array + type: string description: "Part_number does not start with (case-sensitive)" + part_number__regex: + required: false + type: string + description: "Part_number" pass_through_ports: required: false type: boolean @@ -307,39 +439,43 @@ parameters: description: "Has power ports" profile: required: false - type: array + type: string description: "Profile (name)" profile__n: required: false - type: array + type: string description: "Profile not equal to" profile_id: required: false - type: array + type: integer description: "Profile (ID)" profile_id__n: required: false - type: array + type: integer description: "Profile_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -347,7 +483,7 @@ parameters: description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -355,23 +491,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" weight_unit: required: false @@ -380,6 +516,54 @@ parameters: * `g` - Grams * `lb` - Pounds * `oz` - Ounces" + weight_unit__empty: + required: false + type: boolean + description: "Weight_unit is empty/null (boolean)" + weight_unit__ic: + required: false + type: string + description: "Weight_unit contains (case-insensitive)" + weight_unit__ie: + required: false + type: string + description: "Weight_unit exact match (case-insensitive)" + weight_unit__iew: + required: false + type: string + description: "Weight_unit ends with (case-insensitive)" + weight_unit__iregex: + required: false + type: string + description: "Weight_unit" + weight_unit__isw: + required: false + type: string + description: "Weight_unit starts with (case-sensitive)" + weight_unit__n: + required: false + type: string + description: "Weight_unit not equal to" + weight_unit__nic: + required: false + type: string + description: "Weight_unit does not contain (case-insensitive)" + weight_unit__nie: + required: false + type: string + description: "Weight_unit inverse exact match (case-insensitive)" + weight_unit__niew: + required: false + type: string + description: "Weight_unit does not end with (case-insensitive)" + weight_unit__nisw: + required: false + type: string + description: "Weight_unit does not start with (case-sensitive)" + weight_unit__regex: + required: false + type: string + description: "Weight_unit" save_in_key_store: type: boolean default: false diff --git a/actions/get.dcim.modules.yaml b/actions/get.dcim.modules.yaml index f1967f1d..c53bcbf8 100644 --- a/actions/get.dcim.modules.yaml +++ b/actions/get.dcim.modules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of module objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. asset_tag: required: false - type: array + type: string description: "Asset_tag" asset_tag__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Asset_tag is empty/null (boolean)" asset_tag__ic: required: false - type: array + type: string description: "Asset_tag contains (case-insensitive)" asset_tag__ie: required: false - type: array + type: string description: "Asset_tag exact match (case-insensitive)" asset_tag__iew: required: false - type: array + type: string description: "Asset_tag ends with (case-insensitive)" + asset_tag__iregex: + required: false + type: string + description: "Asset_tag" asset_tag__isw: required: false - type: array + type: string description: "Asset_tag starts with (case-sensitive)" asset_tag__n: required: false - type: array + type: string description: "Asset_tag not equal to" asset_tag__nic: required: false - type: array + type: string description: "Asset_tag does not contain (case-insensitive)" asset_tag__nie: required: false - type: array + type: string description: "Asset_tag inverse exact match (case-insensitive)" asset_tag__niew: required: false - type: array + type: string description: "Asset_tag does not end with (case-insensitive)" asset_tag__nisw: required: false - type: array + type: string description: "Asset_tag does not start with (case-sensitive)" + asset_tag__regex: + required: false + type: string + description: "Asset_tag" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,59 +114,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -166,51 +182,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -218,35 +234,35 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" modified_by_request: required: false @@ -254,27 +270,27 @@ parameters: description: "Modified_by_request" module_bay_id: required: false - type: array + type: string description: "Module_bay_id" module_bay_id__n: required: false - type: array + type: string description: "Module_bay_id not equal to" module_type: required: false - type: array + type: string description: "Module type (model)" module_type__n: required: false - type: array + type: string description: "Module_type not equal to" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" offset: required: false @@ -284,45 +300,93 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + profile: + required: false + type: string + description: "Profile (name)" + profile__n: + required: false + type: string + description: "Profile not equal to" + profile_id: + required: false + type: integer + description: "Profile (ID)" + profile_id__n: + required: false + type: integer + description: "Profile_id not equal to" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" serial: required: false - type: array + type: string description: "Serial" serial__empty: required: false @@ -330,75 +394,87 @@ parameters: description: "Serial is empty/null (boolean)" serial__ic: required: false - type: array + type: string description: "Serial contains (case-insensitive)" serial__ie: required: false - type: array + type: string description: "Serial exact match (case-insensitive)" serial__iew: required: false - type: array + type: string description: "Serial ends with (case-insensitive)" + serial__iregex: + required: false + type: string + description: "Serial" serial__isw: required: false - type: array + type: string description: "Serial starts with (case-sensitive)" serial__n: required: false - type: array + type: string description: "Serial not equal to" serial__nic: required: false - type: array + type: string description: "Serial does not contain (case-insensitive)" serial__nie: required: false - type: array + type: string description: "Serial inverse exact match (case-insensitive)" serial__niew: required: false - type: array + type: string description: "Serial does not end with (case-insensitive)" serial__nisw: required: false - type: array + type: string description: "Serial does not start with (case-sensitive)" + serial__regex: + required: false + type: string + description: "Serial" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -406,55 +482,63 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.platforms.yaml b/actions/get.dcim.platforms.yaml index a49eecc8..1a28848c 100644 --- a/actions/get.dcim.platforms.yaml +++ b/actions/get.dcim.platforms.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of platform objects." enabled: true entry_point: run.py @@ -20,45 +20,61 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + ancestor: + required: false + type: string + description: "Ancestor" + ancestor__n: + required: false + type: string + description: "Ancestor not equal to" + ancestor_id: + required: false + type: string + description: "Ancestor_id" + ancestor_id__n: + required: false + type: string + description: "Ancestor_id not equal to" available_for_device_type: required: false type: string description: "Available_for_device_type" config_template_id: required: false - type: array + type: integer description: "Config template (ID)" config_template_id__n: required: false - type: array + type: integer description: "Config_template_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -66,7 +82,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -74,43 +90,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -118,51 +142,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -170,19 +194,19 @@ parameters: description: "Number of results to return per page." manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" modified_by_request: required: false @@ -190,7 +214,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -198,40 +222,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -240,13 +272,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + parent: + required: false + type: string + description: "Immediate parent platform (slug)" + parent__n: + required: false + type: string + description: "Parent not equal to" + parent_id: + required: false + type: integer + description: "Immediate parent platform (ID)" + parent_id__n: + required: false + type: integer + description: "Parent_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -254,55 +334,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.power_feeds.trace.yaml b/actions/get.dcim.power_feeds.trace.yaml index 2dc51504..2138739e 100644 --- a/actions/get.dcim.power_feeds.trace.yaml +++ b/actions/get.dcim.power_feeds.trace.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." enabled: true entry_point: run.py diff --git a/actions/get.dcim.power_feeds.yaml b/actions/get.dcim.power_feeds.yaml index 46a6614d..1cac5b53 100644 --- a/actions/get.dcim.power_feeds.yaml +++ b/actions/get.dcim.power_feeds.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of power feed objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. amperage: required: false - type: array + type: integer description: "Amperage" amperage__empty: required: false @@ -30,27 +30,27 @@ parameters: description: "Amperage is empty/null (boolean)" amperage__gt: required: false - type: array + type: integer description: "Amperage greater than" amperage__gte: required: false - type: array + type: integer description: "Amperage greater than or equal to" amperage__lt: required: false - type: array + type: integer description: "Amperage less than" amperage__lte: required: false - type: array + type: integer description: "Amperage less than or equal to" amperage__n: required: false - type: array + type: integer description: "Amperage not equal to" available_power: required: false - type: array + type: integer description: "Available_power" available_power__empty: required: false @@ -58,36 +58,112 @@ parameters: description: "Available_power is empty/null (boolean)" available_power__gt: required: false - type: array + type: integer description: "Available_power greater than" available_power__gte: required: false - type: array + type: integer description: "Available_power greater than or equal to" available_power__lt: required: false - type: array + type: integer description: "Available_power less than" available_power__lte: required: false - type: array + type: integer description: "Available_power less than or equal to" available_power__n: required: false - type: array + type: integer description: "Available_power not equal to" + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -99,31 +175,31 @@ parameters: description: "Connected" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -131,7 +207,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -139,43 +215,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -183,51 +267,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -239,7 +323,7 @@ parameters: description: "Mark_connected" max_utilization: required: false - type: array + type: integer description: "Max_utilization" max_utilization__empty: required: false @@ -247,23 +331,23 @@ parameters: description: "Max_utilization is empty/null (boolean)" max_utilization__gt: required: false - type: array + type: integer description: "Max_utilization greater than" max_utilization__gte: required: false - type: array + type: integer description: "Max_utilization greater than or equal to" max_utilization__lt: required: false - type: array + type: integer description: "Max_utilization less than" max_utilization__lte: required: false - type: array + type: integer description: "Max_utilization less than or equal to" max_utilization__n: required: false - type: array + type: integer description: "Max_utilization not equal to" modified_by_request: required: false @@ -271,7 +355,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -279,40 +363,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -325,18 +417,98 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" phase: required: false type: string description: "* `single-phase` - Single phase * `three-phase` - Three-phase" + phase__empty: + required: false + type: boolean + description: "Phase is empty/null (boolean)" + phase__ic: + required: false + type: string + description: "Phase contains (case-insensitive)" + phase__ie: + required: false + type: string + description: "Phase exact match (case-insensitive)" + phase__iew: + required: false + type: string + description: "Phase ends with (case-insensitive)" + phase__iregex: + required: false + type: string + description: "Phase" + phase__isw: + required: false + type: string + description: "Phase starts with (case-sensitive)" + phase__n: + required: false + type: string + description: "Phase not equal to" + phase__nic: + required: false + type: string + description: "Phase does not contain (case-insensitive)" + phase__nie: + required: false + type: string + description: "Phase inverse exact match (case-insensitive)" + phase__niew: + required: false + type: string + description: "Phase does not end with (case-insensitive)" + phase__nisw: + required: false + type: string + description: "Phase does not start with (case-sensitive)" + phase__regex: + required: false + type: string + description: "Phase" power_panel_id: required: false - type: array + type: integer description: "Power panel (ID)" power_panel_id__n: required: false - type: array + type: integer description: "Power_panel_id not equal to" q: required: false @@ -344,63 +516,67 @@ parameters: description: "Search" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -408,105 +584,209 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" supply: required: false type: string description: "* `ac` - AC * `dc` - DC" + supply__empty: + required: false + type: boolean + description: "Supply is empty/null (boolean)" + supply__ic: + required: false + type: string + description: "Supply contains (case-insensitive)" + supply__ie: + required: false + type: string + description: "Supply exact match (case-insensitive)" + supply__iew: + required: false + type: string + description: "Supply ends with (case-insensitive)" + supply__iregex: + required: false + type: string + description: "Supply" + supply__isw: + required: false + type: string + description: "Supply starts with (case-sensitive)" + supply__n: + required: false + type: string + description: "Supply not equal to" + supply__nic: + required: false + type: string + description: "Supply does not contain (case-insensitive)" + supply__nie: + required: false + type: string + description: "Supply inverse exact match (case-insensitive)" + supply__niew: + required: false + type: string + description: "Supply does not end with (case-insensitive)" + supply__nisw: + required: false + type: string + description: "Supply does not start with (case-sensitive)" + supply__regex: + required: false + type: string + description: "Supply" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" type: required: false type: string description: "* `primary` - Primary * `redundant` - Redundant" + type__empty: + required: false + type: boolean + description: "Type is empty/null (boolean)" + type__ic: + required: false + type: string + description: "Type contains (case-insensitive)" + type__ie: + required: false + type: string + description: "Type exact match (case-insensitive)" + type__iew: + required: false + type: string + description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" + type__isw: + required: false + type: string + description: "Type starts with (case-sensitive)" + type__n: + required: false + type: string + description: "Type not equal to" + type__nic: + required: false + type: string + description: "Type does not contain (case-insensitive)" + type__nie: + required: false + type: string + description: "Type inverse exact match (case-insensitive)" + type__niew: + required: false + type: string + description: "Type does not end with (case-insensitive)" + type__nisw: + required: false + type: string + description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string description: "Updated_by_request" voltage: required: false - type: array + type: integer description: "Voltage" voltage__empty: required: false @@ -514,23 +794,23 @@ parameters: description: "Voltage is empty/null (boolean)" voltage__gt: required: false - type: array + type: integer description: "Voltage greater than" voltage__gte: required: false - type: array + type: integer description: "Voltage greater than or equal to" voltage__lt: required: false - type: array + type: integer description: "Voltage less than" voltage__lte: required: false - type: array + type: integer description: "Voltage less than or equal to" voltage__n: required: false - type: array + type: integer description: "Voltage not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.power_outlet_templates.yaml b/actions/get.dcim.power_outlet_templates.yaml index 165d3069..ebda2dff 100644 --- a/actions/get.dcim.power_outlet_templates.yaml +++ b/actions/get.dcim.power_outlet_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of power outlet template objects." enabled: true entry_point: run.py @@ -20,33 +20,85 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + color: + required: false + type: string + description: "Color" + color__empty: + required: false + type: boolean + description: "Color is empty/null (boolean)" + color__ic: + required: false + type: string + description: "Color contains (case-insensitive)" + color__ie: + required: false + type: string + description: "Color exact match (case-insensitive)" + color__iew: + required: false + type: string + description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" + color__isw: + required: false + type: string + description: "Color starts with (case-sensitive)" + color__n: + required: false + type: string + description: "Color not equal to" + color__nic: + required: false + type: string + description: "Color does not contain (case-insensitive)" + color__nie: + required: false + type: string + description: "Color inverse exact match (case-insensitive)" + color__niew: + required: false + type: string + description: "Color does not end with (case-insensitive)" + color__nisw: + required: false + type: string + description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,51 +114,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" feed_leg: required: false - type: array + type: string description: "Phase (for three-phase feeds)" feed_leg__empty: required: false @@ -114,43 +174,51 @@ parameters: description: "Feed_leg is empty/null (boolean)" feed_leg__ic: required: false - type: array + type: string description: "Feed_leg contains (case-insensitive)" feed_leg__ie: required: false - type: array + type: string description: "Feed_leg exact match (case-insensitive)" feed_leg__iew: required: false - type: array + type: string description: "Feed_leg ends with (case-insensitive)" + feed_leg__iregex: + required: false + type: string + description: "Phase (for three-phase feeds)" feed_leg__isw: required: false - type: array + type: string description: "Feed_leg starts with (case-sensitive)" feed_leg__n: required: false - type: array + type: string description: "Feed_leg not equal to" feed_leg__nic: required: false - type: array + type: string description: "Feed_leg does not contain (case-insensitive)" feed_leg__nie: required: false - type: array + type: string description: "Feed_leg inverse exact match (case-insensitive)" feed_leg__niew: required: false - type: array + type: string description: "Feed_leg does not end with (case-insensitive)" feed_leg__nisw: required: false - type: array + type: string description: "Feed_leg does not start with (case-sensitive)" + feed_leg__regex: + required: false + type: string + description: "Phase (for three-phase feeds)" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -158,27 +226,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -186,67 +254,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -258,15 +334,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -274,40 +350,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -318,20 +402,24 @@ parameters: description: "Which field to use when ordering the results." power_port_id: required: false - type: array + type: integer description: "Power port (ID)" power_port_id__n: required: false - type: array + type: integer description: "Power_port_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false type: string - description: "* `IEC 60320` - [('iec-60320-c5', 'C5'), ('iec-60320-c7', 'C7'), ('iec-60320-c13', 'C13'), ('iec-60320-c15', 'C15'), ('iec-60320-c19', 'C19'), ('iec-60320-c21', 'C21')] + description: "* `IEC 60320` - [('iec-60320-c5', 'C5'), ('iec-60320-c7', 'C7'), ('iec-60320-c13', 'C13'), ('iec-60320-c15', 'C15'), ('iec-60320-c17', 'C17'), ('iec-60320-c19', 'C19'), ('iec-60320-c21', 'C21')] * `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')] * `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')] * `NEMA (Non-locking)` - [('nema-1-15r', 'NEMA 1-15R'), ('nema-5-15r', 'NEMA 5-15R'), ('nema-5-20r', 'NEMA 5-20R'), ('nema-5-30r', 'NEMA 5-30R'), ('nema-5-50r', 'NEMA 5-50R'), ('nema-6-15r', 'NEMA 6-15R'), ('nema-6-20r', 'NEMA 6-20R'), ('nema-6-30r', 'NEMA 6-30R'), ('nema-6-50r', 'NEMA 6-50R'), ('nema-10-30r', 'NEMA 10-30R'), ('nema-10-50r', 'NEMA 10-50R'), ('nema-14-20r', 'NEMA 14-20R'), ('nema-14-30r', 'NEMA 14-30R'), ('nema-14-50r', 'NEMA 14-50R'), ('nema-14-60r', 'NEMA 14-60R'), ('nema-15-15r', 'NEMA 15-15R'), ('nema-15-20r', 'NEMA 15-20R'), ('nema-15-30r', 'NEMA 15-30R'), ('nema-15-50r', 'NEMA 15-50R'), ('nema-15-60r', 'NEMA 15-60R')] @@ -339,10 +427,58 @@ parameters: * `California Style` - [('CS6360C', 'CS6360C'), ('CS6364C', 'CS6364C'), ('CS8164C', 'CS8164C'), ('CS8264C', 'CS8264C'), ('CS8364C', 'CS8364C'), ('CS8464C', 'CS8464C')] * `ITA/International` - [('ita-e', 'ITA Type E (CEE 7/5)'), ('ita-f', 'ITA Type F (CEE 7/3)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O'), ('ita-multistandard', 'ITA Multistandard')] * `USB` - [('usb-a', 'USB Type A'), ('usb-micro-b', 'USB Micro B'), ('usb-c', 'USB Type C')] -* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] +* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] * `DC` - [('dc-terminal', 'DC Terminal')] * `Proprietary` - [('eaton-c39', 'Eaton C39'), ('hdot-cx', 'HDOT Cx'), ('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20a', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32a', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')] * `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]" + type__empty: + required: false + type: boolean + description: "Type is empty/null (boolean)" + type__ic: + required: false + type: string + description: "Type contains (case-insensitive)" + type__ie: + required: false + type: string + description: "Type exact match (case-insensitive)" + type__iew: + required: false + type: string + description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" + type__isw: + required: false + type: string + description: "Type starts with (case-sensitive)" + type__n: + required: false + type: string + description: "Type not equal to" + type__nic: + required: false + type: string + description: "Type does not contain (case-insensitive)" + type__nie: + required: false + type: string + description: "Type inverse exact match (case-insensitive)" + type__niew: + required: false + type: string + description: "Type does not end with (case-insensitive)" + type__nisw: + required: false + type: string + description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.dcim.power_outlets.trace.yaml b/actions/get.dcim.power_outlets.trace.yaml index 980d9cba..569ac9eb 100644 --- a/actions/get.dcim.power_outlets.trace.yaml +++ b/actions/get.dcim.power_outlets.trace.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." enabled: true entry_point: run.py diff --git a/actions/get.dcim.power_outlets.yaml b/actions/get.dcim.power_outlets.yaml index f171f7ce..30e9e9b3 100644 --- a/actions/get.dcim.power_outlets.yaml +++ b/actions/get.dcim.power_outlets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of power outlet objects." enabled: true entry_point: run.py @@ -20,18 +20,94 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -39,7 +115,7 @@ parameters: description: "Cabled" color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -47,71 +123,79 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" connected: required: false type: boolean description: "Connected" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -119,7 +203,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -127,75 +211,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -203,59 +295,67 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" feed_leg: required: false - type: array + type: string description: "Phase (for three-phase feeds)" feed_leg__empty: required: false @@ -263,43 +363,51 @@ parameters: description: "Feed_leg is empty/null (boolean)" feed_leg__ic: required: false - type: array + type: string description: "Feed_leg contains (case-insensitive)" feed_leg__ie: required: false - type: array + type: string description: "Feed_leg exact match (case-insensitive)" feed_leg__iew: required: false - type: array + type: string description: "Feed_leg ends with (case-insensitive)" + feed_leg__iregex: + required: false + type: string + description: "Phase (for three-phase feeds)" feed_leg__isw: required: false - type: array + type: string description: "Feed_leg starts with (case-sensitive)" feed_leg__n: required: false - type: array + type: string description: "Feed_leg not equal to" feed_leg__nic: required: false - type: array + type: string description: "Feed_leg does not contain (case-insensitive)" feed_leg__nie: required: false - type: array + type: string description: "Feed_leg inverse exact match (case-insensitive)" feed_leg__niew: required: false - type: array + type: string description: "Feed_leg does not end with (case-insensitive)" feed_leg__nisw: required: false - type: array + type: string description: "Feed_leg does not start with (case-sensitive)" + feed_leg__regex: + required: false + type: string + description: "Phase (for three-phase feeds)" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -307,27 +415,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -335,67 +443,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -403,19 +519,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" mark_connected: required: false @@ -427,15 +543,15 @@ parameters: description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -443,40 +559,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -489,13 +613,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" power_port_id: required: false - type: array + type: integer description: "Power port (ID)" power_port_id__n: required: false - type: array + type: integer description: "Power_port_id not equal to" q: required: false @@ -503,71 +659,75 @@ parameters: description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -575,59 +735,83 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Physical port type" type__empty: required: false @@ -635,59 +819,67 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Physical port type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Physical port type" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.power_panels.yaml b/actions/get.dcim.power_panels.yaml index 17b958fc..64833393 100644 --- a/actions/get.dcim.power_panels.yaml +++ b/actions/get.dcim.power_panels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of power panel objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,43 +86,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -130,51 +138,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -182,11 +190,11 @@ parameters: description: "Number of results to return per page." location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" modified_by_request: required: false @@ -194,7 +202,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -202,40 +210,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -244,73 +260,109 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.power_port_templates.yaml b/actions/get.dcim.power_port_templates.yaml index af1432d3..dbab2da8 100644 --- a/actions/get.dcim.power_port_templates.yaml +++ b/actions/get.dcim.power_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of power port template objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. allocated_draw: required: false - type: array + type: integer description: "Allocated_draw" allocated_draw__empty: required: false @@ -30,51 +30,51 @@ parameters: description: "Allocated_draw is empty/null (boolean)" allocated_draw__gt: required: false - type: array + type: integer description: "Allocated_draw greater than" allocated_draw__gte: required: false - type: array + type: integer description: "Allocated_draw greater than or equal to" allocated_draw__lt: required: false - type: array + type: integer description: "Allocated_draw less than" allocated_draw__lte: required: false - type: array + type: integer description: "Allocated_draw less than or equal to" allocated_draw__n: required: false - type: array + type: integer description: "Allocated_draw not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -82,7 +82,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -90,51 +90,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -142,27 +150,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -170,67 +178,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -238,7 +254,7 @@ parameters: description: "Number of results to return per page." maximum_draw: required: false - type: array + type: integer description: "Maximum_draw" maximum_draw__empty: required: false @@ -246,23 +262,23 @@ parameters: description: "Maximum_draw is empty/null (boolean)" maximum_draw__gt: required: false - type: array + type: integer description: "Maximum_draw greater than" maximum_draw__gte: required: false - type: array + type: integer description: "Maximum_draw greater than or equal to" maximum_draw__lt: required: false - type: array + type: integer description: "Maximum_draw less than" maximum_draw__lte: required: false - type: array + type: integer description: "Maximum_draw less than or equal to" maximum_draw__n: required: false - type: array + type: integer description: "Maximum_draw not equal to" modified_by_request: required: false @@ -270,15 +286,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -286,40 +302,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -332,10 +356,14 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false type: string - description: "* `IEC 60320` - [('iec-60320-c6', 'C6'), ('iec-60320-c8', 'C8'), ('iec-60320-c14', 'C14'), ('iec-60320-c16', 'C16'), ('iec-60320-c20', 'C20'), ('iec-60320-c22', 'C22')] + description: "* `IEC 60320` - [('iec-60320-c6', 'C6'), ('iec-60320-c8', 'C8'), ('iec-60320-c14', 'C14'), ('iec-60320-c16', 'C16'), ('iec-60320-c18', 'C18'), ('iec-60320-c20', 'C20'), ('iec-60320-c22', 'C22')] * `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')] * `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')] * `NEMA (Non-locking)` - [('nema-1-15p', 'NEMA 1-15P'), ('nema-5-15p', 'NEMA 5-15P'), ('nema-5-20p', 'NEMA 5-20P'), ('nema-5-30p', 'NEMA 5-30P'), ('nema-5-50p', 'NEMA 5-50P'), ('nema-6-15p', 'NEMA 6-15P'), ('nema-6-20p', 'NEMA 6-20P'), ('nema-6-30p', 'NEMA 6-30P'), ('nema-6-50p', 'NEMA 6-50P'), ('nema-10-30p', 'NEMA 10-30P'), ('nema-10-50p', 'NEMA 10-50P'), ('nema-14-20p', 'NEMA 14-20P'), ('nema-14-30p', 'NEMA 14-30P'), ('nema-14-50p', 'NEMA 14-50P'), ('nema-14-60p', 'NEMA 14-60P'), ('nema-15-15p', 'NEMA 15-15P'), ('nema-15-20p', 'NEMA 15-20P'), ('nema-15-30p', 'NEMA 15-30P'), ('nema-15-50p', 'NEMA 15-50P'), ('nema-15-60p', 'NEMA 15-60P')] @@ -343,10 +371,58 @@ parameters: * `California Style` - [('cs6361c', 'CS6361C'), ('cs6365c', 'CS6365C'), ('cs8165c', 'CS8165C'), ('cs8265c', 'CS8265C'), ('cs8365c', 'CS8365C'), ('cs8465c', 'CS8465C')] * `International/ITA` - [('ita-c', 'ITA Type C (CEE 7/16)'), ('ita-e', 'ITA Type E (CEE 7/6)'), ('ita-f', 'ITA Type F (CEE 7/4)'), ('ita-ef', 'ITA Type E/F (CEE 7/7)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O')] * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB'), ('usb-3-b', 'USB 3.0 Type B'), ('usb-3-micro-b', 'USB 3.0 Micro B')] -* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] +* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] * `DC` - [('dc-terminal', 'DC Terminal')] * `Proprietary` - [('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')] * `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]" + type__empty: + required: false + type: boolean + description: "Type is empty/null (boolean)" + type__ic: + required: false + type: string + description: "Type contains (case-insensitive)" + type__ie: + required: false + type: string + description: "Type exact match (case-insensitive)" + type__iew: + required: false + type: string + description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" + type__isw: + required: false + type: string + description: "Type starts with (case-sensitive)" + type__n: + required: false + type: string + description: "Type not equal to" + type__nic: + required: false + type: string + description: "Type does not contain (case-insensitive)" + type__nie: + required: false + type: string + description: "Type inverse exact match (case-insensitive)" + type__niew: + required: false + type: string + description: "Type does not end with (case-insensitive)" + type__nisw: + required: false + type: string + description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.dcim.power_ports.trace.yaml b/actions/get.dcim.power_ports.trace.yaml index d9369903..61aafba8 100644 --- a/actions/get.dcim.power_ports.trace.yaml +++ b/actions/get.dcim.power_ports.trace.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." enabled: true entry_point: run.py diff --git a/actions/get.dcim.power_ports.yaml b/actions/get.dcim.power_ports.yaml index 666e5402..1179b506 100644 --- a/actions/get.dcim.power_ports.yaml +++ b/actions/get.dcim.power_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of power port objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. allocated_draw: required: false - type: array + type: integer description: "Allocated_draw" allocated_draw__empty: required: false @@ -30,36 +30,112 @@ parameters: description: "Allocated_draw is empty/null (boolean)" allocated_draw__gt: required: false - type: array + type: integer description: "Allocated_draw greater than" allocated_draw__gte: required: false - type: array + type: integer description: "Allocated_draw greater than or equal to" allocated_draw__lt: required: false - type: array + type: integer description: "Allocated_draw less than" allocated_draw__lte: required: false - type: array + type: integer description: "Allocated_draw less than or equal to" allocated_draw__n: required: false - type: array + type: integer description: "Allocated_draw not equal to" + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -71,31 +147,31 @@ parameters: description: "Connected" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -103,7 +179,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -111,75 +187,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -187,59 +271,67 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -247,27 +339,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -275,67 +367,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -343,19 +443,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" mark_connected: required: false @@ -363,7 +463,7 @@ parameters: description: "Mark_connected" maximum_draw: required: false - type: array + type: integer description: "Maximum_draw" maximum_draw__empty: required: false @@ -371,23 +471,23 @@ parameters: description: "Maximum_draw is empty/null (boolean)" maximum_draw__gt: required: false - type: array + type: integer description: "Maximum_draw greater than" maximum_draw__gte: required: false - type: array + type: integer description: "Maximum_draw greater than or equal to" maximum_draw__lt: required: false - type: array + type: integer description: "Maximum_draw less than" maximum_draw__lte: required: false - type: array + type: integer description: "Maximum_draw less than or equal to" maximum_draw__n: required: false - type: array + type: integer description: "Maximum_draw not equal to" modified_by_request: required: false @@ -395,15 +495,15 @@ parameters: description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -411,40 +511,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -457,93 +565,145 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Physical port type" type__empty: required: false @@ -551,59 +711,67 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Physical port type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Physical port type" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.rack_groups.yaml b/actions/get.dcim.rack_groups.yaml new file mode 100644 index 00000000..40bd2c64 --- /dev/null +++ b/actions/get.dcim.rack_groups.yaml @@ -0,0 +1,354 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Get a list of rack group objects." +enabled: true +entry_point: run.py +name: get.dcim.rack_groups +parameters: + endpoint_uri: + default: "/dcim/rack-groups/" + immutable: true + type: string + http_verb: + default: get + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + created: + required: false + type: string + description: "Created" + created__empty: + required: false + type: string + description: "Created is empty/null (boolean)" + created__gt: + required: false + type: string + description: "Created greater than" + created__gte: + required: false + type: string + description: "Created greater than or equal to" + created__lt: + required: false + type: string + description: "Created less than" + created__lte: + required: false + type: string + description: "Created less than or equal to" + created__n: + required: false + type: string + description: "Created not equal to" + created_by_request: + required: false + type: string + description: "Created_by_request" + description: + required: false + type: string + description: "Description" + description__empty: + required: false + type: boolean + description: "Description is empty/null (boolean)" + description__ic: + required: false + type: string + description: "Description contains (case-insensitive)" + description__ie: + required: false + type: string + description: "Description exact match (case-insensitive)" + description__iew: + required: false + type: string + description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" + description__isw: + required: false + type: string + description: "Description starts with (case-sensitive)" + description__n: + required: false + type: string + description: "Description not equal to" + description__nic: + required: false + type: string + description: "Description does not contain (case-insensitive)" + description__nie: + required: false + type: string + description: "Description inverse exact match (case-insensitive)" + description__niew: + required: false + type: string + description: "Description does not end with (case-insensitive)" + description__nisw: + required: false + type: string + description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + id: + required: false + type: integer + description: "Id" + id__empty: + required: false + type: boolean + description: "Id is empty/null (boolean)" + id__gt: + required: false + type: integer + description: "Id greater than" + id__gte: + required: false + type: integer + description: "Id greater than or equal to" + id__lt: + required: false + type: integer + description: "Id less than" + id__lte: + required: false + type: integer + description: "Id less than or equal to" + id__n: + required: false + type: integer + description: "Id not equal to" + last_updated: + required: false + type: string + description: "Last_updated" + last_updated__empty: + required: false + type: string + description: "Last_updated is empty/null (boolean)" + last_updated__gt: + required: false + type: string + description: "Last_updated greater than" + last_updated__gte: + required: false + type: string + description: "Last_updated greater than or equal to" + last_updated__lt: + required: false + type: string + description: "Last_updated less than" + last_updated__lte: + required: false + type: string + description: "Last_updated less than or equal to" + last_updated__n: + required: false + type: string + description: "Last_updated not equal to" + limit: + required: false + type: integer + description: "Number of results to return per page." + modified_by_request: + required: false + type: string + description: "Modified_by_request" + name: + required: false + type: string + description: "Name" + name__empty: + required: false + type: boolean + description: "Name is empty/null (boolean)" + name__ic: + required: false + type: string + description: "Name contains (case-insensitive)" + name__ie: + required: false + type: string + description: "Name exact match (case-insensitive)" + name__iew: + required: false + type: string + description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" + name__isw: + required: false + type: string + description: "Name starts with (case-sensitive)" + name__n: + required: false + type: string + description: "Name not equal to" + name__nic: + required: false + type: string + description: "Name does not contain (case-insensitive)" + name__nie: + required: false + type: string + description: "Name inverse exact match (case-insensitive)" + name__niew: + required: false + type: string + description: "Name does not end with (case-insensitive)" + name__nisw: + required: false + type: string + description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" + offset: + required: false + type: integer + description: "The initial index from which to return the results." + ordering: + required: false + type: string + description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + q: + required: false + type: string + description: "Search" + slug: + required: false + type: string + description: "Slug" + slug__empty: + required: false + type: boolean + description: "Slug is empty/null (boolean)" + slug__ic: + required: false + type: string + description: "Slug contains (case-insensitive)" + slug__ie: + required: false + type: string + description: "Slug exact match (case-insensitive)" + slug__iew: + required: false + type: string + description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" + slug__isw: + required: false + type: string + description: "Slug starts with (case-sensitive)" + slug__n: + required: false + type: string + description: "Slug not equal to" + slug__nic: + required: false + type: string + description: "Slug does not contain (case-insensitive)" + slug__nie: + required: false + type: string + description: "Slug inverse exact match (case-insensitive)" + slug__niew: + required: false + type: string + description: "Slug does not end with (case-insensitive)" + slug__nisw: + required: false + type: string + description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + tag: + required: false + type: string + description: "Tag" + tag__n: + required: false + type: string + description: "Tag not equal to" + tag_id: + required: false + type: integer + description: "Tag_id" + tag_id__n: + required: false + type: integer + description: "Tag_id not equal to" + updated_by_request: + required: false + type: string + description: "Updated_by_request" + save_in_key_store: + type: boolean + default: false + description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. + save_in_key_store_key_name: + type: string + description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. + save_in_key_store_ttl: + type: integer + default: 60 + description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. +runner_type: python-script diff --git a/actions/get.dcim.rack_reservations.yaml b/actions/get.dcim.rack_reservations.yaml index 9f8e92f8..1e2956db 100644 --- a/actions/get.dcim.rack_reservations.yaml +++ b/actions/get.dcim.rack_reservations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of rack reservation objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + group: + required: false + type: string + description: "Group (slug)" + group__n: + required: false + type: string + description: "Group not equal to" + group_id: + required: false + type: integer + description: "Group (ID)" + group_id__n: + required: false + type: integer + description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +130,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -158,19 +182,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" modified_by_request: required: false @@ -184,137 +208,257 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + status: + required: false + type: string + description: "Status" + status__empty: + required: false + type: boolean + description: "Status is empty/null (boolean)" + status__ic: + required: false + type: string + description: "Status contains (case-insensitive)" + status__ie: + required: false + type: string + description: "Status exact match (case-insensitive)" + status__iew: + required: false + type: string + description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" + status__isw: + required: false + type: string + description: "Status starts with (case-sensitive)" + status__n: + required: false + type: string + description: "Status not equal to" + status__nic: + required: false + type: string + description: "Status does not contain (case-insensitive)" + status__nie: + required: false + type: string + description: "Status inverse exact match (case-insensitive)" + status__niew: + required: false + type: string + description: "Status does not end with (case-insensitive)" + status__nisw: + required: false + type: string + description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" unit: required: false type: integer description: "Unit" + unit__empty: + required: false + type: integer + description: "Unit is empty/null (boolean)" + unit__gt: + required: false + type: integer + description: "Unit greater than" + unit__gte: + required: false + type: integer + description: "Unit greater than or equal to" + unit__lt: + required: false + type: integer + description: "Unit less than" + unit__lte: + required: false + type: integer + description: "Unit less than or equal to" + unit__n: + required: false + type: integer + description: "Unit not equal to" + unit_count_max: + required: false + type: integer + description: "Maximum unit count" + unit_count_min: + required: false + type: integer + description: "Minimum unit count" updated_by_request: required: false type: string description: "Updated_by_request" user: required: false - type: array + type: string description: "User (name)" user__n: required: false - type: array + type: string description: "User not equal to" user_id: required: false - type: array + type: integer description: "User (ID)" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.rack_roles.yaml b/actions/get.dcim.rack_roles.yaml index 565fec7d..15757687 100644 --- a/actions/get.dcim.rack_roles.yaml +++ b/actions/get.dcim.rack_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of rack role objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,51 +166,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -206,7 +222,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -214,40 +230,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -256,13 +280,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -270,55 +326,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.rack_types.yaml b/actions/get.dcim.rack_types.yaml index 7b2abd1d..2b85c64c 100644 --- a/actions/get.dcim.rack_types.yaml +++ b/actions/get.dcim.rack_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of rack type objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -58,7 +58,7 @@ parameters: description: "Desc_units" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -66,43 +66,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" form_factor: required: false - type: array + type: string description: "Form_factor" form_factor__empty: required: false @@ -110,43 +118,51 @@ parameters: description: "Form_factor is empty/null (boolean)" form_factor__ic: required: false - type: array + type: string description: "Form_factor contains (case-insensitive)" form_factor__ie: required: false - type: array + type: string description: "Form_factor exact match (case-insensitive)" form_factor__iew: required: false - type: array + type: string description: "Form_factor ends with (case-insensitive)" + form_factor__iregex: + required: false + type: string + description: "Form_factor" form_factor__isw: required: false - type: array + type: string description: "Form_factor starts with (case-sensitive)" form_factor__n: required: false - type: array + type: string description: "Form_factor not equal to" form_factor__nic: required: false - type: array + type: string description: "Form_factor does not contain (case-insensitive)" form_factor__nie: required: false - type: array + type: string description: "Form_factor inverse exact match (case-insensitive)" form_factor__niew: required: false - type: array + type: string description: "Form_factor does not end with (case-insensitive)" form_factor__nisw: required: false - type: array + type: string description: "Form_factor does not start with (case-sensitive)" + form_factor__regex: + required: false + type: string + description: "Form_factor" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -154,51 +170,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -206,23 +222,23 @@ parameters: description: "Number of results to return per page." manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" max_weight: required: false - type: array + type: integer description: "Max_weight" max_weight__empty: required: false @@ -230,27 +246,27 @@ parameters: description: "Max_weight is empty/null (boolean)" max_weight__gt: required: false - type: array + type: integer description: "Max_weight greater than" max_weight__gte: required: false - type: array + type: integer description: "Max_weight greater than or equal to" max_weight__lt: required: false - type: array + type: integer description: "Max_weight less than" max_weight__lte: required: false - type: array + type: integer description: "Max_weight less than or equal to" max_weight__n: required: false - type: array + type: integer description: "Max_weight not equal to" model: required: false - type: array + type: string description: "Model" model__empty: required: false @@ -258,47 +274,55 @@ parameters: description: "Model is empty/null (boolean)" model__ic: required: false - type: array + type: string description: "Model contains (case-insensitive)" model__ie: required: false - type: array + type: string description: "Model exact match (case-insensitive)" model__iew: required: false - type: array + type: string description: "Model ends with (case-insensitive)" + model__iregex: + required: false + type: string + description: "Model" model__isw: required: false - type: array + type: string description: "Model starts with (case-sensitive)" model__n: required: false - type: array + type: string description: "Model not equal to" model__nic: required: false - type: array + type: string description: "Model does not contain (case-insensitive)" model__nie: required: false - type: array + type: string description: "Model inverse exact match (case-insensitive)" model__niew: required: false - type: array + type: string description: "Model does not end with (case-insensitive)" model__nisw: required: false - type: array + type: string description: "Model does not start with (case-sensitive)" + model__regex: + required: false + type: string + description: "Model" modified_by_request: required: false type: string description: "Modified_by_request" mounting_depth: required: false - type: array + type: integer description: "Mounting_depth" mounting_depth__empty: required: false @@ -306,23 +330,23 @@ parameters: description: "Mounting_depth is empty/null (boolean)" mounting_depth__gt: required: false - type: array + type: integer description: "Mounting_depth greater than" mounting_depth__gte: required: false - type: array + type: integer description: "Mounting_depth greater than or equal to" mounting_depth__lt: required: false - type: array + type: integer description: "Mounting_depth less than" mounting_depth__lte: required: false - type: array + type: integer description: "Mounting_depth less than or equal to" mounting_depth__n: required: false - type: array + type: integer description: "Mounting_depth not equal to" offset: required: false @@ -334,7 +358,7 @@ parameters: description: "Which field to use when ordering the results." outer_depth: required: false - type: array + type: integer description: "Outer_depth" outer_depth__empty: required: false @@ -342,27 +366,27 @@ parameters: description: "Outer_depth is empty/null (boolean)" outer_depth__gt: required: false - type: array + type: integer description: "Outer_depth greater than" outer_depth__gte: required: false - type: array + type: integer description: "Outer_depth greater than or equal to" outer_depth__lt: required: false - type: array + type: integer description: "Outer_depth less than" outer_depth__lte: required: false - type: array + type: integer description: "Outer_depth less than or equal to" outer_depth__n: required: false - type: array + type: integer description: "Outer_depth not equal to" outer_height: required: false - type: array + type: integer description: "Outer_height" outer_height__empty: required: false @@ -370,32 +394,80 @@ parameters: description: "Outer_height is empty/null (boolean)" outer_height__gt: required: false - type: array + type: integer description: "Outer_height greater than" outer_height__gte: required: false - type: array + type: integer description: "Outer_height greater than or equal to" outer_height__lt: required: false - type: array + type: integer description: "Outer_height less than" outer_height__lte: required: false - type: array + type: integer description: "Outer_height less than or equal to" outer_height__n: required: false - type: array + type: integer description: "Outer_height not equal to" outer_unit: required: false type: string description: "* `mm` - Millimeters * `in` - Inches" + outer_unit__empty: + required: false + type: boolean + description: "Outer_unit is empty/null (boolean)" + outer_unit__ic: + required: false + type: string + description: "Outer_unit contains (case-insensitive)" + outer_unit__ie: + required: false + type: string + description: "Outer_unit exact match (case-insensitive)" + outer_unit__iew: + required: false + type: string + description: "Outer_unit ends with (case-insensitive)" + outer_unit__iregex: + required: false + type: string + description: "Outer_unit" + outer_unit__isw: + required: false + type: string + description: "Outer_unit starts with (case-sensitive)" + outer_unit__n: + required: false + type: string + description: "Outer_unit not equal to" + outer_unit__nic: + required: false + type: string + description: "Outer_unit does not contain (case-insensitive)" + outer_unit__nie: + required: false + type: string + description: "Outer_unit inverse exact match (case-insensitive)" + outer_unit__niew: + required: false + type: string + description: "Outer_unit does not end with (case-insensitive)" + outer_unit__nisw: + required: false + type: string + description: "Outer_unit does not start with (case-sensitive)" + outer_unit__regex: + required: false + type: string + description: "Outer_unit" outer_width: required: false - type: array + type: integer description: "Outer_width" outer_width__empty: required: false @@ -403,31 +475,91 @@ parameters: description: "Outer_width is empty/null (boolean)" outer_width__gt: required: false - type: array + type: integer description: "Outer_width greater than" outer_width__gte: required: false - type: array + type: integer description: "Outer_width greater than or equal to" outer_width__lt: required: false - type: array + type: integer description: "Outer_width less than" outer_width__lte: required: false - type: array + type: integer description: "Outer_width less than or equal to" outer_width__n: required: false - type: array + type: integer description: "Outer_width not equal to" + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + rack_count: + required: false + type: integer + description: "Rack_count" + rack_count__empty: + required: false + type: boolean + description: "Rack_count is empty/null (boolean)" + rack_count__gt: + required: false + type: integer + description: "Rack_count greater than" + rack_count__gte: + required: false + type: integer + description: "Rack_count greater than or equal to" + rack_count__lt: + required: false + type: integer + description: "Rack_count less than" + rack_count__lte: + required: false + type: integer + description: "Rack_count less than or equal to" + rack_count__n: + required: false + type: integer + description: "Rack_count not equal to" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -435,43 +567,55 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." starting_unit: required: false - type: array + type: integer description: "Starting_unit" starting_unit__empty: required: false @@ -479,43 +623,43 @@ parameters: description: "Starting_unit is empty/null (boolean)" starting_unit__gt: required: false - type: array + type: integer description: "Starting_unit greater than" starting_unit__gte: required: false - type: array + type: integer description: "Starting_unit greater than or equal to" starting_unit__lt: required: false - type: array + type: integer description: "Starting_unit less than" starting_unit__lte: required: false - type: array + type: integer description: "Starting_unit less than or equal to" starting_unit__n: required: false - type: array + type: integer description: "Starting_unit not equal to" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" u_height: required: false - type: array + type: integer description: "U_height" u_height__empty: required: false @@ -523,23 +667,23 @@ parameters: description: "U_height is empty/null (boolean)" u_height__gt: required: false - type: array + type: integer description: "U_height greater than" u_height__gte: required: false - type: array + type: integer description: "U_height greater than or equal to" u_height__lt: required: false - type: array + type: integer description: "U_height less than" u_height__lte: required: false - type: array + type: integer description: "U_height less than or equal to" u_height__n: required: false - type: array + type: integer description: "U_height not equal to" updated_by_request: required: false @@ -547,7 +691,7 @@ parameters: description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -555,23 +699,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" weight_unit: required: false @@ -580,46 +724,102 @@ parameters: * `g` - Grams * `lb` - Pounds * `oz` - Ounces" + weight_unit__empty: + required: false + type: boolean + description: "Weight_unit is empty/null (boolean)" + weight_unit__ic: + required: false + type: string + description: "Weight_unit contains (case-insensitive)" + weight_unit__ie: + required: false + type: string + description: "Weight_unit exact match (case-insensitive)" + weight_unit__iew: + required: false + type: string + description: "Weight_unit ends with (case-insensitive)" + weight_unit__iregex: + required: false + type: string + description: "Weight_unit" + weight_unit__isw: + required: false + type: string + description: "Weight_unit starts with (case-sensitive)" + weight_unit__n: + required: false + type: string + description: "Weight_unit not equal to" + weight_unit__nic: + required: false + type: string + description: "Weight_unit does not contain (case-insensitive)" + weight_unit__nie: + required: false + type: string + description: "Weight_unit inverse exact match (case-insensitive)" + weight_unit__niew: + required: false + type: string + description: "Weight_unit does not end with (case-insensitive)" + weight_unit__nisw: + required: false + type: string + description: "Weight_unit does not start with (case-sensitive)" + weight_unit__regex: + required: false + type: string + description: "Weight_unit" width: required: false - type: array + type: integer description: "Rail-to-rail width" width__ic: required: false - type: array + type: integer description: "Width contains (case-insensitive)" width__ie: required: false - type: array + type: integer description: "Width exact match (case-insensitive)" width__iew: required: false - type: array + type: integer description: "Width ends with (case-insensitive)" + width__iregex: + required: false + type: integer + description: "Rail-to-rail width" width__isw: required: false - type: array + type: integer description: "Width starts with (case-sensitive)" width__n: required: false - type: array + type: integer description: "Width not equal to" width__nic: required: false - type: array + type: integer description: "Width does not contain (case-insensitive)" width__nie: required: false - type: array + type: integer description: "Width inverse exact match (case-insensitive)" width__niew: required: false - type: array + type: integer description: "Width does not end with (case-insensitive)" width__nisw: required: false - type: array + type: integer description: "Width does not start with (case-sensitive)" + width__regex: + required: false + type: integer + description: "Rail-to-rail width" save_in_key_store: type: boolean default: false diff --git a/actions/get.dcim.racks.elevation.yaml b/actions/get.dcim.racks.elevation.yaml index 6641464f..6dca3e3c 100644 --- a/actions/get.dcim.racks.elevation.yaml +++ b/actions/get.dcim.racks.elevation.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG." enabled: true entry_point: run.py diff --git a/actions/get.dcim.racks.yaml b/actions/get.dcim.racks.yaml index a02e6106..4dd9cbdb 100644 --- a/actions/get.dcim.racks.yaml +++ b/actions/get.dcim.racks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of rack objects." enabled: true entry_point: run.py @@ -25,9 +25,57 @@ parameters: type: string description: "* `front-to-rear` - Front to rear * `rear-to-front` - Rear to front" + airflow__empty: + required: false + type: boolean + description: "Airflow is empty/null (boolean)" + airflow__ic: + required: false + type: string + description: "Airflow contains (case-insensitive)" + airflow__ie: + required: false + type: string + description: "Airflow exact match (case-insensitive)" + airflow__iew: + required: false + type: string + description: "Airflow ends with (case-insensitive)" + airflow__iregex: + required: false + type: string + description: "Airflow" + airflow__isw: + required: false + type: string + description: "Airflow starts with (case-sensitive)" + airflow__n: + required: false + type: string + description: "Airflow not equal to" + airflow__nic: + required: false + type: string + description: "Airflow does not contain (case-insensitive)" + airflow__nie: + required: false + type: string + description: "Airflow inverse exact match (case-insensitive)" + airflow__niew: + required: false + type: string + description: "Airflow does not end with (case-insensitive)" + airflow__nisw: + required: false + type: string + description: "Airflow does not start with (case-sensitive)" + airflow__regex: + required: false + type: string + description: "Airflow" asset_tag: required: false - type: array + type: string description: "Asset_tag" asset_tag__empty: required: false @@ -35,91 +83,99 @@ parameters: description: "Asset_tag is empty/null (boolean)" asset_tag__ic: required: false - type: array + type: string description: "Asset_tag contains (case-insensitive)" asset_tag__ie: required: false - type: array + type: string description: "Asset_tag exact match (case-insensitive)" asset_tag__iew: required: false - type: array + type: string description: "Asset_tag ends with (case-insensitive)" + asset_tag__iregex: + required: false + type: string + description: "Asset_tag" asset_tag__isw: required: false - type: array + type: string description: "Asset_tag starts with (case-sensitive)" asset_tag__n: required: false - type: array + type: string description: "Asset_tag not equal to" asset_tag__nic: required: false - type: array + type: string description: "Asset_tag does not contain (case-insensitive)" asset_tag__nie: required: false - type: array + type: string description: "Asset_tag inverse exact match (case-insensitive)" asset_tag__niew: required: false - type: array + type: string description: "Asset_tag does not end with (case-insensitive)" asset_tag__nisw: required: false - type: array + type: string description: "Asset_tag does not start with (case-sensitive)" + asset_tag__regex: + required: false + type: string + description: "Asset_tag" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -131,7 +187,7 @@ parameters: description: "Desc_units" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -139,43 +195,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" facility_id: required: false - type: array + type: string description: "Facility_id" facility_id__empty: required: false @@ -183,43 +247,51 @@ parameters: description: "Facility_id is empty/null (boolean)" facility_id__ic: required: false - type: array + type: string description: "Facility_id contains (case-insensitive)" facility_id__ie: required: false - type: array + type: string description: "Facility_id exact match (case-insensitive)" facility_id__iew: required: false - type: array + type: string description: "Facility_id ends with (case-insensitive)" + facility_id__iregex: + required: false + type: string + description: "Facility_id" facility_id__isw: required: false - type: array + type: string description: "Facility_id starts with (case-sensitive)" facility_id__n: required: false - type: array + type: string description: "Facility_id not equal to" facility_id__nic: required: false - type: array + type: string description: "Facility_id does not contain (case-insensitive)" facility_id__nie: required: false - type: array + type: string description: "Facility_id inverse exact match (case-insensitive)" facility_id__niew: required: false - type: array + type: string description: "Facility_id does not end with (case-insensitive)" facility_id__nisw: required: false - type: array + type: string description: "Facility_id does not start with (case-sensitive)" + facility_id__regex: + required: false + type: string + description: "Facility_id" form_factor: required: false - type: array + type: string description: "Form_factor" form_factor__empty: required: false @@ -227,43 +299,67 @@ parameters: description: "Form_factor is empty/null (boolean)" form_factor__ic: required: false - type: array + type: string description: "Form_factor contains (case-insensitive)" form_factor__ie: required: false - type: array + type: string description: "Form_factor exact match (case-insensitive)" form_factor__iew: required: false - type: array + type: string description: "Form_factor ends with (case-insensitive)" + form_factor__iregex: + required: false + type: string + description: "Form_factor" form_factor__isw: required: false - type: array + type: string description: "Form_factor starts with (case-sensitive)" form_factor__n: required: false - type: array + type: string description: "Form_factor not equal to" form_factor__nic: required: false - type: array + type: string description: "Form_factor does not contain (case-insensitive)" form_factor__nie: required: false - type: array + type: string description: "Form_factor inverse exact match (case-insensitive)" form_factor__niew: required: false - type: array + type: string description: "Form_factor does not end with (case-insensitive)" form_factor__nisw: required: false - type: array + type: string description: "Form_factor does not start with (case-sensitive)" + form_factor__regex: + required: false + type: string + description: "Form_factor" + group: + required: false + type: string + description: "Group (slug)" + group__n: + required: false + type: string + description: "Group not equal to" + group_id: + required: false + type: integer + description: "Group (ID)" + group_id__n: + required: false + type: integer + description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -271,51 +367,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -323,39 +419,39 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" manufacturer: required: false - type: array + type: string description: "Manufacturer (slug)" manufacturer__n: required: false - type: array + type: string description: "Manufacturer not equal to" manufacturer_id: required: false - type: array + type: integer description: "Manufacturer (ID)" manufacturer_id__n: required: false - type: array + type: integer description: "Manufacturer_id not equal to" max_weight: required: false - type: array + type: integer description: "Max_weight" max_weight__empty: required: false @@ -363,23 +459,23 @@ parameters: description: "Max_weight is empty/null (boolean)" max_weight__gt: required: false - type: array + type: integer description: "Max_weight greater than" max_weight__gte: required: false - type: array + type: integer description: "Max_weight greater than or equal to" max_weight__lt: required: false - type: array + type: integer description: "Max_weight less than" max_weight__lte: required: false - type: array + type: integer description: "Max_weight less than or equal to" max_weight__n: required: false - type: array + type: integer description: "Max_weight not equal to" modified_by_request: required: false @@ -387,7 +483,7 @@ parameters: description: "Modified_by_request" mounting_depth: required: false - type: array + type: integer description: "Mounting_depth" mounting_depth__empty: required: false @@ -395,27 +491,27 @@ parameters: description: "Mounting_depth is empty/null (boolean)" mounting_depth__gt: required: false - type: array + type: integer description: "Mounting_depth greater than" mounting_depth__gte: required: false - type: array + type: integer description: "Mounting_depth greater than or equal to" mounting_depth__lt: required: false - type: array + type: integer description: "Mounting_depth less than" mounting_depth__lte: required: false - type: array + type: integer description: "Mounting_depth less than or equal to" mounting_depth__n: required: false - type: array + type: integer description: "Mounting_depth not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -423,40 +519,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -467,7 +571,7 @@ parameters: description: "Which field to use when ordering the results." outer_depth: required: false - type: array + type: integer description: "Outer_depth" outer_depth__empty: required: false @@ -475,27 +579,27 @@ parameters: description: "Outer_depth is empty/null (boolean)" outer_depth__gt: required: false - type: array + type: integer description: "Outer_depth greater than" outer_depth__gte: required: false - type: array + type: integer description: "Outer_depth greater than or equal to" outer_depth__lt: required: false - type: array + type: integer description: "Outer_depth less than" outer_depth__lte: required: false - type: array + type: integer description: "Outer_depth less than or equal to" outer_depth__n: required: false - type: array + type: integer description: "Outer_depth not equal to" outer_height: required: false - type: array + type: integer description: "Outer_height" outer_height__empty: required: false @@ -503,32 +607,80 @@ parameters: description: "Outer_height is empty/null (boolean)" outer_height__gt: required: false - type: array + type: integer description: "Outer_height greater than" outer_height__gte: required: false - type: array + type: integer description: "Outer_height greater than or equal to" outer_height__lt: required: false - type: array + type: integer description: "Outer_height less than" outer_height__lte: required: false - type: array + type: integer description: "Outer_height less than or equal to" outer_height__n: required: false - type: array + type: integer description: "Outer_height not equal to" outer_unit: required: false type: string description: "* `mm` - Millimeters * `in` - Inches" + outer_unit__empty: + required: false + type: boolean + description: "Outer_unit is empty/null (boolean)" + outer_unit__ic: + required: false + type: string + description: "Outer_unit contains (case-insensitive)" + outer_unit__ie: + required: false + type: string + description: "Outer_unit exact match (case-insensitive)" + outer_unit__iew: + required: false + type: string + description: "Outer_unit ends with (case-insensitive)" + outer_unit__iregex: + required: false + type: string + description: "Outer_unit" + outer_unit__isw: + required: false + type: string + description: "Outer_unit starts with (case-sensitive)" + outer_unit__n: + required: false + type: string + description: "Outer_unit not equal to" + outer_unit__nic: + required: false + type: string + description: "Outer_unit does not contain (case-insensitive)" + outer_unit__nie: + required: false + type: string + description: "Outer_unit inverse exact match (case-insensitive)" + outer_unit__niew: + required: false + type: string + description: "Outer_unit does not end with (case-insensitive)" + outer_unit__nisw: + required: false + type: string + description: "Outer_unit does not start with (case-sensitive)" + outer_unit__regex: + required: false + type: string + description: "Outer_unit" outer_width: required: false - type: array + type: integer description: "Outer_width" outer_width__empty: required: false @@ -536,79 +688,111 @@ parameters: description: "Outer_width is empty/null (boolean)" outer_width__gt: required: false - type: array + type: integer description: "Outer_width greater than" outer_width__gte: required: false - type: array + type: integer description: "Outer_width greater than or equal to" outer_width__lt: required: false - type: array + type: integer description: "Outer_width less than" outer_width__lte: required: false - type: array + type: integer description: "Outer_width less than or equal to" outer_width__n: required: false - type: array + type: integer description: "Outer_width not equal to" + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rack_type: required: false - type: array + type: string description: "Rack type (slug)" rack_type__n: required: false - type: array + type: string description: "Rack_type not equal to" rack_type_id: required: false - type: array + type: integer description: "Rack type (ID)" rack_type_id__n: required: false - type: array + type: integer description: "Rack_type_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" role: required: false - type: array + type: string description: "Role (slug)" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: integer description: "Role (ID)" role_id__n: required: false - type: array + type: integer description: "Role_id not equal to" serial: required: false - type: array + type: string description: "Serial" serial__empty: required: false @@ -616,75 +800,87 @@ parameters: description: "Serial is empty/null (boolean)" serial__ic: required: false - type: array + type: string description: "Serial contains (case-insensitive)" serial__ie: required: false - type: array + type: string description: "Serial exact match (case-insensitive)" serial__iew: required: false - type: array + type: string description: "Serial ends with (case-insensitive)" + serial__iregex: + required: false + type: string + description: "Serial" serial__isw: required: false - type: array + type: string description: "Serial starts with (case-sensitive)" serial__n: required: false - type: array + type: string description: "Serial not equal to" serial__nic: required: false - type: array + type: string description: "Serial does not contain (case-insensitive)" serial__nie: required: false - type: array + type: string description: "Serial inverse exact match (case-insensitive)" serial__niew: required: false - type: array + type: string description: "Serial does not end with (case-insensitive)" serial__nisw: required: false - type: array + type: string description: "Serial does not start with (case-sensitive)" + serial__regex: + required: false + type: string + description: "Serial" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." starting_unit: required: false - type: array + type: integer description: "Starting_unit" starting_unit__empty: required: false @@ -692,27 +888,27 @@ parameters: description: "Starting_unit is empty/null (boolean)" starting_unit__gt: required: false - type: array + type: integer description: "Starting_unit greater than" starting_unit__gte: required: false - type: array + type: integer description: "Starting_unit greater than or equal to" starting_unit__lt: required: false - type: array + type: integer description: "Starting_unit less than" starting_unit__lte: required: false - type: array + type: integer description: "Starting_unit less than or equal to" starting_unit__n: required: false - type: array + type: integer description: "Starting_unit not equal to" status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -720,91 +916,99 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" u_height: required: false - type: array + type: integer description: "U_height" u_height__empty: required: false @@ -812,23 +1016,23 @@ parameters: description: "U_height is empty/null (boolean)" u_height__gt: required: false - type: array + type: integer description: "U_height greater than" u_height__gte: required: false - type: array + type: integer description: "U_height greater than or equal to" u_height__lt: required: false - type: array + type: integer description: "U_height less than" u_height__lte: required: false - type: array + type: integer description: "U_height less than or equal to" u_height__n: required: false - type: array + type: integer description: "U_height not equal to" updated_by_request: required: false @@ -836,7 +1040,7 @@ parameters: description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -844,23 +1048,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" weight_unit: required: false @@ -869,46 +1073,102 @@ parameters: * `g` - Grams * `lb` - Pounds * `oz` - Ounces" + weight_unit__empty: + required: false + type: boolean + description: "Weight_unit is empty/null (boolean)" + weight_unit__ic: + required: false + type: string + description: "Weight_unit contains (case-insensitive)" + weight_unit__ie: + required: false + type: string + description: "Weight_unit exact match (case-insensitive)" + weight_unit__iew: + required: false + type: string + description: "Weight_unit ends with (case-insensitive)" + weight_unit__iregex: + required: false + type: string + description: "Weight_unit" + weight_unit__isw: + required: false + type: string + description: "Weight_unit starts with (case-sensitive)" + weight_unit__n: + required: false + type: string + description: "Weight_unit not equal to" + weight_unit__nic: + required: false + type: string + description: "Weight_unit does not contain (case-insensitive)" + weight_unit__nie: + required: false + type: string + description: "Weight_unit inverse exact match (case-insensitive)" + weight_unit__niew: + required: false + type: string + description: "Weight_unit does not end with (case-insensitive)" + weight_unit__nisw: + required: false + type: string + description: "Weight_unit does not start with (case-sensitive)" + weight_unit__regex: + required: false + type: string + description: "Weight_unit" width: required: false - type: array + type: integer description: "Rail-to-rail width" width__ic: required: false - type: array + type: integer description: "Width contains (case-insensitive)" width__ie: required: false - type: array + type: integer description: "Width exact match (case-insensitive)" width__iew: required: false - type: array + type: integer description: "Width ends with (case-insensitive)" + width__iregex: + required: false + type: integer + description: "Rail-to-rail width" width__isw: required: false - type: array + type: integer description: "Width starts with (case-sensitive)" width__n: required: false - type: array + type: integer description: "Width not equal to" width__nic: required: false - type: array + type: integer description: "Width does not contain (case-insensitive)" width__nie: required: false - type: array + type: integer description: "Width inverse exact match (case-insensitive)" width__niew: required: false - type: array + type: integer description: "Width does not end with (case-insensitive)" width__nisw: required: false - type: array + type: integer description: "Width does not start with (case-sensitive)" + width__regex: + required: false + type: integer + description: "Rail-to-rail width" save_in_key_store: type: boolean default: false diff --git a/actions/get.dcim.rear_port_templates.yaml b/actions/get.dcim.rear_port_templates.yaml index 5655f2cf..11ad665f 100644 --- a/actions/get.dcim.rear_port_templates.yaml +++ b/actions/get.dcim.rear_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of rear port template objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,51 +114,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" + front_port_id: + required: false + type: integer + description: "Front port (ID)" + front_port_id__n: + required: false + type: integer + description: "Front_port_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -158,27 +182,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -186,67 +210,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -258,15 +290,15 @@ parameters: description: "Modified_by_request" module_type_id: required: false - type: array + type: integer description: "Module type (ID)" module_type_id__n: required: false - type: array + type: integer description: "Module_type_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -274,40 +306,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -318,7 +358,7 @@ parameters: description: "Which field to use when ordering the results." positions: required: false - type: array + type: integer description: "Positions" positions__empty: required: false @@ -326,31 +366,35 @@ parameters: description: "Positions is empty/null (boolean)" positions__gt: required: false - type: array + type: integer description: "Positions greater than" positions__gte: required: false - type: array + type: integer description: "Positions greater than or equal to" positions__lt: required: false - type: array + type: integer description: "Positions less than" positions__lte: required: false - type: array + type: integer description: "Positions less than or equal to" positions__n: required: false - type: array + type: integer description: "Positions not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -358,40 +402,48 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.dcim.rear_ports.paths.yaml b/actions/get.dcim.rear_ports.paths.yaml index 31721e62..cc298b1d 100644 --- a/actions/get.dcim.rear_ports.paths.yaml +++ b/actions/get.dcim.rear_ports.paths.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Return all CablePaths which traverse a given pass-through port." enabled: true entry_point: run.py diff --git a/actions/get.dcim.rear_ports.yaml b/actions/get.dcim.rear_ports.yaml index 31748b0c..cdd2f2d5 100644 --- a/actions/get.dcim.rear_ports.yaml +++ b/actions/get.dcim.rear_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of rear port objects." enabled: true entry_point: run.py @@ -20,18 +20,94 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + cable_connector: + required: false + type: integer + description: "Cable_connector" + cable_connector__empty: + required: false + type: boolean + description: "Cable_connector is empty/null (boolean)" + cable_connector__gt: + required: false + type: integer + description: "Cable_connector greater than" + cable_connector__gte: + required: false + type: integer + description: "Cable_connector greater than or equal to" + cable_connector__lt: + required: false + type: integer + description: "Cable_connector less than" + cable_connector__lte: + required: false + type: integer + description: "Cable_connector less than or equal to" + cable_connector__n: + required: false + type: integer + description: "Cable_connector not equal to" cable_end: required: false type: string description: "* `A` - A * `B` - B" + cable_end__empty: + required: false + type: boolean + description: "Cable_end is empty/null (boolean)" + cable_end__ic: + required: false + type: string + description: "Cable_end contains (case-insensitive)" + cable_end__ie: + required: false + type: string + description: "Cable_end exact match (case-insensitive)" + cable_end__iew: + required: false + type: string + description: "Cable_end ends with (case-insensitive)" + cable_end__iregex: + required: false + type: string + description: "Cable_end" + cable_end__isw: + required: false + type: string + description: "Cable_end starts with (case-sensitive)" + cable_end__n: + required: false + type: string + description: "Cable_end not equal to" + cable_end__nic: + required: false + type: string + description: "Cable_end does not contain (case-insensitive)" + cable_end__nie: + required: false + type: string + description: "Cable_end inverse exact match (case-insensitive)" + cable_end__niew: + required: false + type: string + description: "Cable_end does not end with (case-insensitive)" + cable_end__nisw: + required: false + type: string + description: "Cable_end does not start with (case-sensitive)" + cable_end__regex: + required: false + type: string + description: "Cable_end" cable_id: required: false - type: array + type: integer description: "Cable (ID)" cable_id__n: required: false - type: array + type: integer description: "Cable_id not equal to" cabled: required: false @@ -39,7 +115,7 @@ parameters: description: "Cabled" color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -47,67 +123,75 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -115,7 +199,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -123,75 +207,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" device_role: required: false - type: array + type: string description: "Device role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Device role (ID)" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_status: required: false - type: array + type: string description: "Device_status" device_status__empty: required: false @@ -199,59 +291,75 @@ parameters: description: "Device_status is empty/null (boolean)" device_status__ic: required: false - type: array + type: string description: "Device_status contains (case-insensitive)" device_status__ie: required: false - type: array + type: string description: "Device_status exact match (case-insensitive)" device_status__iew: required: false - type: array + type: string description: "Device_status ends with (case-insensitive)" + device_status__iregex: + required: false + type: string + description: "Device_status" device_status__isw: required: false - type: array + type: string description: "Device_status starts with (case-sensitive)" device_status__n: required: false - type: array + type: string description: "Device_status not equal to" device_status__nic: required: false - type: array + type: string description: "Device_status does not contain (case-insensitive)" device_status__nie: required: false - type: array + type: string description: "Device_status inverse exact match (case-insensitive)" device_status__niew: required: false - type: array + type: string description: "Device_status does not end with (case-insensitive)" device_status__nisw: required: false - type: array + type: string description: "Device_status does not start with (case-sensitive)" + device_status__regex: + required: false + type: string + description: "Device_status" device_type: required: false - type: array + type: string description: "Device type (model)" device_type__n: required: false - type: array + type: string description: "Device_type not equal to" device_type_id: required: false - type: array + type: integer description: "Device type (ID)" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" + front_port_id: + required: false + type: integer + description: "Front port (ID)" + front_port_id__n: + required: false + type: integer + description: "Front_port_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -259,27 +367,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -287,67 +395,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -355,19 +471,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location (ID)" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" mark_connected: required: false @@ -379,15 +495,15 @@ parameters: description: "Modified_by_request" module_id: required: false - type: array + type: integer description: "Module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -395,40 +511,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" occupied: required: false type: boolean @@ -441,9 +565,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" positions: required: false - type: array + type: integer description: "Positions" positions__empty: required: false @@ -451,23 +607,23 @@ parameters: description: "Positions is empty/null (boolean)" positions__gt: required: false - type: array + type: integer description: "Positions greater than" positions__gte: required: false - type: array + type: integer description: "Positions greater than or equal to" positions__lt: required: false - type: array + type: integer description: "Positions less than" positions__lte: required: false - type: array + type: integer description: "Positions less than or equal to" positions__n: required: false - type: array + type: integer description: "Positions not equal to" q: required: false @@ -475,87 +631,107 @@ parameters: description: "Search" rack: required: false - type: array + type: string description: "Rack (name)" rack__n: required: false - type: array + type: string description: "Rack not equal to" rack_id: required: false - type: array + type: integer description: "Rack (ID)" rack_id__n: required: false - type: array + type: integer description: "Rack_id not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" + tenant: + required: false + type: string + description: "Tenant (slug)" + tenant__n: + required: false + type: string + description: "Tenant not equal to" + tenant_id: + required: false + type: integer + description: "Tenant (ID)" + tenant_id__n: + required: false + type: integer + description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -563,59 +739,67 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string description: "Updated_by_request" virtual_chassis: required: false - type: array + type: string description: "Virtual Chassis" virtual_chassis__n: required: false - type: array + type: string description: "Virtual_chassis not equal to" virtual_chassis_id: required: false - type: array + type: integer description: "Virtual Chassis (ID)" virtual_chassis_id__n: required: false - type: array + type: integer description: "Virtual_chassis_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.dcim.regions.yaml b/actions/get.dcim.regions.yaml index adb53f43..69b1ead6 100644 --- a/actions/get.dcim.regions.yaml +++ b/actions/get.dcim.regions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of region objects." enabled: true entry_point: run.py @@ -22,71 +22,71 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ancestor: required: false - type: array + type: string description: "Ancestor" ancestor__n: required: false - type: array + type: string description: "Ancestor not equal to" ancestor_id: required: false - type: array + type: string description: "Ancestor_id" ancestor_id__n: required: false - type: array + type: string description: "Ancestor_id not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -94,7 +94,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -102,43 +102,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -146,51 +154,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -202,7 +210,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -210,40 +218,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -252,21 +268,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent region (slug)" parent__n: required: false - type: array + type: string description: "Parent not equal to" parent_id: required: false - type: array + type: integer description: "Parent region (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" q: required: false @@ -274,7 +322,7 @@ parameters: description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -282,55 +330,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.site_groups.yaml b/actions/get.dcim.site_groups.yaml index f9e946d8..25cfd956 100644 --- a/actions/get.dcim.site_groups.yaml +++ b/actions/get.dcim.site_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of site group objects." enabled: true entry_point: run.py @@ -22,71 +22,71 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ancestor: required: false - type: array + type: string description: "Ancestor" ancestor__n: required: false - type: array + type: string description: "Ancestor not equal to" ancestor_id: required: false - type: array + type: string description: "Ancestor_id" ancestor_id__n: required: false - type: array + type: string description: "Ancestor_id not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -94,7 +94,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -102,43 +102,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -146,51 +154,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -202,7 +210,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -210,40 +218,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -252,21 +268,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent site group (slug)" parent__n: required: false - type: array + type: string description: "Parent not equal to" parent_id: required: false - type: array + type: integer description: "Parent site group (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" q: required: false @@ -274,7 +322,7 @@ parameters: description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -282,55 +330,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.sites.yaml b/actions/get.dcim.sites.yaml index 30890fec..efda5582 100644 --- a/actions/get.dcim.sites.yaml +++ b/actions/get.dcim.sites.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of site objects." enabled: true entry_point: run.py @@ -22,71 +22,71 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. asn: required: false - type: array + type: integer description: "AS (ID)" asn__n: required: false - type: array + type: integer description: "Asn not equal to" asn_id: required: false - type: array + type: integer description: "AS (ID)" asn_id__n: required: false - type: array + type: integer description: "Asn_id not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -94,7 +94,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -102,43 +102,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" facility: required: false - type: array + type: string description: "Facility" facility__empty: required: false @@ -146,59 +154,67 @@ parameters: description: "Facility is empty/null (boolean)" facility__ic: required: false - type: array + type: string description: "Facility contains (case-insensitive)" facility__ie: required: false - type: array + type: string description: "Facility exact match (case-insensitive)" facility__iew: required: false - type: array + type: string description: "Facility ends with (case-insensitive)" + facility__iregex: + required: false + type: string + description: "Facility" facility__isw: required: false - type: array + type: string description: "Facility starts with (case-sensitive)" facility__n: required: false - type: array + type: string description: "Facility not equal to" facility__nic: required: false - type: array + type: string description: "Facility does not contain (case-insensitive)" facility__nie: required: false - type: array + type: string description: "Facility inverse exact match (case-insensitive)" facility__niew: required: false - type: array + type: string description: "Facility does not end with (case-insensitive)" facility__nisw: required: false - type: array + type: string description: "Facility does not start with (case-sensitive)" + facility__regex: + required: false + type: string + description: "Facility" group: required: false - type: array + type: string description: "Group" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: string description: "Group_id" group_id__n: required: false - type: array + type: string description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -206,55 +222,55 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" latitude: required: false - type: array + type: integer description: "Latitude" latitude__empty: required: false @@ -262,23 +278,23 @@ parameters: description: "Latitude is empty/null (boolean)" latitude__gt: required: false - type: array + type: integer description: "Latitude greater than" latitude__gte: required: false - type: array + type: integer description: "Latitude greater than or equal to" latitude__lt: required: false - type: array + type: integer description: "Latitude less than" latitude__lte: required: false - type: array + type: integer description: "Latitude less than or equal to" latitude__n: required: false - type: array + type: integer description: "Latitude not equal to" limit: required: false @@ -286,7 +302,7 @@ parameters: description: "Number of results to return per page." longitude: required: false - type: array + type: integer description: "Longitude" longitude__empty: required: false @@ -294,23 +310,23 @@ parameters: description: "Longitude is empty/null (boolean)" longitude__gt: required: false - type: array + type: integer description: "Longitude greater than" longitude__gte: required: false - type: array + type: integer description: "Longitude greater than or equal to" longitude__lt: required: false - type: array + type: integer description: "Longitude less than" longitude__lte: required: false - type: array + type: integer description: "Longitude less than or equal to" longitude__n: required: false - type: array + type: integer description: "Longitude not equal to" modified_by_request: required: false @@ -318,7 +334,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -326,40 +342,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -368,29 +392,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -398,43 +454,55 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -442,128 +510,144 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" time_zone: required: false - type: array + type: string description: "Time_zone" time_zone__ic: required: false - type: array + type: string description: "Time_zone contains (case-insensitive)" time_zone__ie: required: false - type: array + type: string description: "Time_zone exact match (case-insensitive)" time_zone__iew: required: false - type: array + type: string description: "Time_zone ends with (case-insensitive)" + time_zone__iregex: + required: false + type: string + description: "Time_zone" time_zone__isw: required: false - type: array + type: string description: "Time_zone starts with (case-sensitive)" time_zone__n: required: false - type: array + type: string description: "Time_zone not equal to" time_zone__nic: required: false - type: array + type: string description: "Time_zone does not contain (case-insensitive)" time_zone__nie: required: false - type: array + type: string description: "Time_zone inverse exact match (case-insensitive)" time_zone__niew: required: false - type: array + type: string description: "Time_zone does not end with (case-insensitive)" time_zone__nisw: required: false - type: array + type: string description: "Time_zone does not start with (case-sensitive)" + time_zone__regex: + required: false + type: string + description: "Time_zone" updated_by_request: required: false type: string diff --git a/actions/get.dcim.virtual_chassis.yaml b/actions/get.dcim.virtual_chassis.yaml index 0bf79290..940742be 100644 --- a/actions/get.dcim.virtual_chassis.yaml +++ b/actions/get.dcim.virtual_chassis.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of virtual chassis objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" domain: required: false - type: array + type: string description: "Domain" domain__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Domain is empty/null (boolean)" domain__ic: required: false - type: array + type: string description: "Domain contains (case-insensitive)" domain__ie: required: false - type: array + type: string description: "Domain exact match (case-insensitive)" domain__iew: required: false - type: array + type: string description: "Domain ends with (case-insensitive)" + domain__iregex: + required: false + type: string + description: "Domain" domain__isw: required: false - type: array + type: string description: "Domain starts with (case-sensitive)" domain__n: required: false - type: array + type: string description: "Domain not equal to" domain__nic: required: false - type: array + type: string description: "Domain does not contain (case-insensitive)" domain__nie: required: false - type: array + type: string description: "Domain inverse exact match (case-insensitive)" domain__niew: required: false - type: array + type: string description: "Domain does not end with (case-insensitive)" domain__nisw: required: false - type: array + type: string description: "Domain does not start with (case-sensitive)" + domain__regex: + required: false + type: string + description: "Domain" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -150,51 +166,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -202,23 +218,23 @@ parameters: description: "Number of results to return per page." master: required: false - type: array + type: string description: "Master (name)" master__n: required: false - type: array + type: string description: "Master not equal to" master_id: required: false - type: array + type: integer description: "Master (ID)" master_id__n: required: false - type: array + type: integer description: "Master_id not equal to" member_count: required: false - type: array + type: integer description: "Member_count" member_count__empty: required: false @@ -226,23 +242,23 @@ parameters: description: "Member_count is empty/null (boolean)" member_count__gt: required: false - type: array + type: integer description: "Member_count greater than" member_count__gte: required: false - type: array + type: integer description: "Member_count greater than or equal to" member_count__lt: required: false - type: array + type: integer description: "Member_count less than" member_count__lte: required: false - type: array + type: integer description: "Member_count less than or equal to" member_count__n: required: false - type: array + type: integer description: "Member_count not equal to" modified_by_request: required: false @@ -250,7 +266,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -258,40 +274,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -300,89 +324,125 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site name (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.dcim.virtual_device_contexts.yaml b/actions/get.dcim.virtual_device_contexts.yaml index c210c109..e4b1b04d 100644 --- a/actions/get.dcim.virtual_device_contexts.yaml +++ b/actions/get.dcim.virtual_device_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of virtual device context objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,55 +62,63 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: integer description: "Device model" device__n: required: false - type: array + type: integer description: "Device not equal to" device_id: required: false - type: array + type: integer description: "VDC (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" has_primary_ip: required: false @@ -118,7 +126,7 @@ parameters: description: "Has a primary IP" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -126,27 +134,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" identifier: required: false - type: array + type: integer description: "Identifier" identifier__empty: required: false @@ -154,59 +162,59 @@ parameters: description: "Identifier is empty/null (boolean)" identifier__gt: required: false - type: array + type: integer description: "Identifier greater than" identifier__gte: required: false - type: array + type: integer description: "Identifier greater than or equal to" identifier__lt: required: false - type: array + type: integer description: "Identifier less than" identifier__lte: required: false - type: array + type: integer description: "Identifier less than or equal to" identifier__n: required: false - type: array + type: integer description: "Identifier not equal to" interface_id: required: false - type: array + type: integer description: "Interface (ID)" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -218,7 +226,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -226,40 +234,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -268,45 +284,81 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" primary_ip4: required: false - type: array + type: string description: "Primary IPv4 (address)" primary_ip4__n: required: false - type: array + type: string description: "Primary_ip4 not equal to" primary_ip4_id: required: false - type: array + type: integer description: "Primary IPv4 (ID)" primary_ip4_id__n: required: false - type: array + type: integer description: "Primary_ip4_id not equal to" primary_ip6: required: false - type: array + type: string description: "Primary IPv6 (address)" primary_ip6__n: required: false - type: array + type: string description: "Primary_ip6 not equal to" primary_ip6_id: required: false - type: array + type: integer description: "Primary IPv6 (ID)" primary_ip6_id__n: required: false - type: array + type: integer description: "Primary_ip6_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -314,87 +366,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.extras.bookmarks.yaml b/actions/get.extras.bookmarks.yaml index 53988a52..271508aa 100644 --- a/actions/get.extras.bookmarks.yaml +++ b/actions/get.extras.bookmarks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of bookmark objects." enabled: true entry_point: run.py @@ -26,7 +26,7 @@ parameters: description: "Created" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -34,23 +34,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" limit: required: false @@ -58,7 +58,7 @@ parameters: description: "Number of results to return per page." object_id: required: false - type: array + type: integer description: "Object_id" object_id__empty: required: false @@ -66,23 +66,23 @@ parameters: description: "Object_id is empty/null (boolean)" object_id__gt: required: false - type: array + type: integer description: "Object_id greater than" object_id__gte: required: false - type: array + type: integer description: "Object_id greater than or equal to" object_id__lt: required: false - type: array + type: integer description: "Object_id less than" object_id__lte: required: false - type: array + type: integer description: "Object_id less than or equal to" object_id__n: required: false - type: array + type: integer description: "Object_id not equal to" object_type: required: false @@ -94,31 +94,31 @@ parameters: description: "Object_type not equal to" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__empty: required: false - type: array + type: integer description: "Object_type_id is empty/null (boolean)" object_type_id__gt: required: false - type: array + type: integer description: "Object_type_id greater than" object_type_id__gte: required: false - type: array + type: integer description: "Object_type_id greater than or equal to" object_type_id__lt: required: false - type: array + type: integer description: "Object_type_id less than" object_type_id__lte: required: false - type: array + type: integer description: "Object_type_id less than or equal to" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -128,21 +128,25 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." user: required: false - type: array + type: string description: "User (name)" user__n: required: false - type: array + type: string description: "User not equal to" user_id: required: false - type: array + type: integer description: "User (ID)" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.config_context_profiles.yaml b/actions/get.extras.config_context_profiles.yaml new file mode 100644 index 00000000..47ac1685 --- /dev/null +++ b/actions/get.extras.config_context_profiles.yaml @@ -0,0 +1,350 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Get a list of config context profile objects." +enabled: true +entry_point: run.py +name: get.extras.config_context_profiles +parameters: + endpoint_uri: + default: "/extras/config-context-profiles/" + immutable: true + type: string + http_verb: + default: get + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + auto_sync_enabled: + required: false + type: boolean + description: "Auto_sync_enabled" + created: + required: false + type: string + description: "Created" + created__empty: + required: false + type: string + description: "Created is empty/null (boolean)" + created__gt: + required: false + type: string + description: "Created greater than" + created__gte: + required: false + type: string + description: "Created greater than or equal to" + created__lt: + required: false + type: string + description: "Created less than" + created__lte: + required: false + type: string + description: "Created less than or equal to" + created__n: + required: false + type: string + description: "Created not equal to" + created_by_request: + required: false + type: string + description: "Created_by_request" + data_file_id: + required: false + type: integer + description: "Data file (ID)" + data_file_id__n: + required: false + type: integer + description: "Data_file_id not equal to" + data_source_id: + required: false + type: integer + description: "Data source (ID)" + data_source_id__n: + required: false + type: integer + description: "Data_source_id not equal to" + data_synced: + required: false + type: string + description: "Data_synced" + data_synced__empty: + required: false + type: boolean + description: "Data_synced is empty/null (boolean)" + data_synced__gt: + required: false + type: string + description: "Data_synced greater than" + data_synced__gte: + required: false + type: string + description: "Data_synced greater than or equal to" + data_synced__lt: + required: false + type: string + description: "Data_synced less than" + data_synced__lte: + required: false + type: string + description: "Data_synced less than or equal to" + data_synced__n: + required: false + type: string + description: "Data_synced not equal to" + description: + required: false + type: string + description: "Description" + description__empty: + required: false + type: boolean + description: "Description is empty/null (boolean)" + description__ic: + required: false + type: string + description: "Description contains (case-insensitive)" + description__ie: + required: false + type: string + description: "Description exact match (case-insensitive)" + description__iew: + required: false + type: string + description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" + description__isw: + required: false + type: string + description: "Description starts with (case-sensitive)" + description__n: + required: false + type: string + description: "Description not equal to" + description__nic: + required: false + type: string + description: "Description does not contain (case-insensitive)" + description__nie: + required: false + type: string + description: "Description inverse exact match (case-insensitive)" + description__niew: + required: false + type: string + description: "Description does not end with (case-insensitive)" + description__nisw: + required: false + type: string + description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + id: + required: false + type: integer + description: "Id" + id__empty: + required: false + type: boolean + description: "Id is empty/null (boolean)" + id__gt: + required: false + type: integer + description: "Id greater than" + id__gte: + required: false + type: integer + description: "Id greater than or equal to" + id__lt: + required: false + type: integer + description: "Id less than" + id__lte: + required: false + type: integer + description: "Id less than or equal to" + id__n: + required: false + type: integer + description: "Id not equal to" + last_updated: + required: false + type: string + description: "Last_updated" + last_updated__empty: + required: false + type: string + description: "Last_updated is empty/null (boolean)" + last_updated__gt: + required: false + type: string + description: "Last_updated greater than" + last_updated__gte: + required: false + type: string + description: "Last_updated greater than or equal to" + last_updated__lt: + required: false + type: string + description: "Last_updated less than" + last_updated__lte: + required: false + type: string + description: "Last_updated less than or equal to" + last_updated__n: + required: false + type: string + description: "Last_updated not equal to" + limit: + required: false + type: integer + description: "Number of results to return per page." + modified_by_request: + required: false + type: string + description: "Modified_by_request" + name: + required: false + type: string + description: "Name" + name__empty: + required: false + type: boolean + description: "Name is empty/null (boolean)" + name__ic: + required: false + type: string + description: "Name contains (case-insensitive)" + name__ie: + required: false + type: string + description: "Name exact match (case-insensitive)" + name__iew: + required: false + type: string + description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" + name__isw: + required: false + type: string + description: "Name starts with (case-sensitive)" + name__n: + required: false + type: string + description: "Name not equal to" + name__nic: + required: false + type: string + description: "Name does not contain (case-insensitive)" + name__nie: + required: false + type: string + description: "Name inverse exact match (case-insensitive)" + name__niew: + required: false + type: string + description: "Name does not end with (case-insensitive)" + name__nisw: + required: false + type: string + description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" + offset: + required: false + type: integer + description: "The initial index from which to return the results." + ordering: + required: false + type: string + description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + q: + required: false + type: string + description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + tag: + required: false + type: string + description: "Tag" + tag__n: + required: false + type: string + description: "Tag not equal to" + tag_id: + required: false + type: integer + description: "Tag_id" + tag_id__n: + required: false + type: integer + description: "Tag_id not equal to" + updated_by_request: + required: false + type: string + description: "Updated_by_request" + save_in_key_store: + type: boolean + default: false + description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. + save_in_key_store_key_name: + type: string + description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. + save_in_key_store_ttl: + type: integer + default: 60 + description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. +runner_type: python-script diff --git a/actions/get.extras.config_contexts.yaml b/actions/get.extras.config_contexts.yaml index 9d248b04..c97e7dc6 100644 --- a/actions/get.extras.config_contexts.yaml +++ b/actions/get.extras.config_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of config context objects." enabled: true entry_point: run.py @@ -26,71 +26,71 @@ parameters: description: "Auto_sync_enabled" cluster_group: required: false - type: array + type: string description: "Cluster group (slug)" cluster_group__n: required: false - type: array + type: string description: "Cluster_group not equal to" cluster_group_id: required: false - type: array + type: integer description: "Cluster group" cluster_group_id__n: required: false - type: array + type: integer description: "Cluster_group_id not equal to" cluster_id: required: false - type: array + type: integer description: "Cluster" cluster_id__n: required: false - type: array + type: integer description: "Cluster_id not equal to" cluster_type: required: false - type: array + type: string description: "Cluster type (slug)" cluster_type__n: required: false - type: array + type: string description: "Cluster_type not equal to" cluster_type_id: required: false - type: array + type: integer description: "Cluster type" cluster_type_id__n: required: false - type: array + type: integer description: "Cluster_type_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,23 +98,23 @@ parameters: description: "Created_by_request" data_file_id: required: false - type: array + type: integer description: "Data file (ID)" data_file_id__n: required: false - type: array + type: integer description: "Data_file_id not equal to" data_source_id: required: false - type: array + type: integer description: "Data source (ID)" data_source_id__n: required: false - type: array + type: integer description: "Data_source_id not equal to" data_synced: required: false - type: array + type: string description: "Data_synced" data_synced__empty: required: false @@ -122,27 +122,27 @@ parameters: description: "Data_synced is empty/null (boolean)" data_synced__gt: required: false - type: array + type: string description: "Data_synced greater than" data_synced__gte: required: false - type: array + type: string description: "Data_synced greater than or equal to" data_synced__lt: required: false - type: array + type: string description: "Data_synced less than" data_synced__lte: required: false - type: array + type: string description: "Data_synced less than or equal to" data_synced__n: required: false - type: array + type: string description: "Data_synced not equal to" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -150,67 +150,75 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device_role: required: false - type: array + type: string description: "Role (slug)" device_role__n: required: false - type: array + type: string description: "Device_role not equal to" device_role_id: required: false - type: array + type: integer description: "Role" device_role_id__n: required: false - type: array + type: integer description: "Device_role_id not equal to" device_type_id: required: false - type: array + type: integer description: "Device type" device_type_id__n: required: false - type: array + type: integer description: "Device_type_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -218,23 +226,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" is_active: required: false @@ -242,31 +250,31 @@ parameters: description: "Is_active" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -274,19 +282,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location (slug)" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: integer description: "Location" location_id__n: required: false - type: array + type: integer description: "Location_id not equal to" modified_by_request: required: false @@ -294,7 +302,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -302,40 +310,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -344,121 +360,173 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" platform: required: false - type: array + type: string description: "Platform (slug)" platform__n: required: false - type: array + type: string description: "Platform not equal to" platform_id: required: false - type: array + type: integer description: "Platform" platform_id__n: required: false - type: array + type: integer description: "Platform_id not equal to" + profile: + required: false + type: string + description: "Profile (name)" + profile__n: + required: false + type: string + description: "Profile not equal to" + profile_id: + required: false + type: integer + description: "Profile (ID)" + profile_id__n: + required: false + type: integer + description: "Profile_id not equal to" q: required: false type: string description: "Search" region: required: false - type: array + type: string description: "Region (slug)" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: integer description: "Region" region_id__n: required: false - type: array + type: integer description: "Region_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site group (slug)" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: integer description: "Site group" site_group_id__n: required: false - type: array + type: integer description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag (slug)" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant group (slug)" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: integer description: "Tenant group" tenant_group_id__n: required: false - type: array + type: integer description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -466,7 +534,7 @@ parameters: description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -474,23 +542,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.config_templates.yaml b/actions/get.extras.config_templates.yaml index b4cd7caf..35ac510a 100644 --- a/actions/get.extras.config_templates.yaml +++ b/actions/get.extras.config_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of config template objects." enabled: true entry_point: run.py @@ -30,31 +30,31 @@ parameters: description: "Auto_sync_enabled" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -62,23 +62,23 @@ parameters: description: "Created_by_request" data_file_id: required: false - type: array + type: integer description: "Data file (ID)" data_file_id__n: required: false - type: array + type: integer description: "Data_file_id not equal to" data_source_id: required: false - type: array + type: integer description: "Data source (ID)" data_source_id__n: required: false - type: array + type: integer description: "Data_source_id not equal to" data_synced: required: false - type: array + type: string description: "Data_synced" data_synced__empty: required: false @@ -86,27 +86,31 @@ parameters: description: "Data_synced is empty/null (boolean)" data_synced__gt: required: false - type: array + type: string description: "Data_synced greater than" data_synced__gte: required: false - type: array + type: string description: "Data_synced greater than or equal to" data_synced__lt: required: false - type: array + type: string description: "Data_synced less than" data_synced__lte: required: false - type: array + type: string description: "Data_synced less than or equal to" data_synced__n: required: false - type: array + type: string description: "Data_synced not equal to" + debug: + required: false + type: boolean + description: "Debug" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -114,43 +118,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" file_extension: required: false - type: array + type: string description: "File_extension" file_extension__empty: required: false @@ -158,43 +170,51 @@ parameters: description: "File_extension is empty/null (boolean)" file_extension__ic: required: false - type: array + type: string description: "File_extension contains (case-insensitive)" file_extension__ie: required: false - type: array + type: string description: "File_extension exact match (case-insensitive)" file_extension__iew: required: false - type: array + type: string description: "File_extension ends with (case-insensitive)" + file_extension__iregex: + required: false + type: string + description: "File_extension" file_extension__isw: required: false - type: array + type: string description: "File_extension starts with (case-sensitive)" file_extension__n: required: false - type: array + type: string description: "File_extension not equal to" file_extension__nic: required: false - type: array + type: string description: "File_extension does not contain (case-insensitive)" file_extension__nie: required: false - type: array + type: string description: "File_extension inverse exact match (case-insensitive)" file_extension__niew: required: false - type: array + type: string description: "File_extension does not end with (case-insensitive)" file_extension__nisw: required: false - type: array + type: string description: "File_extension does not start with (case-sensitive)" + file_extension__regex: + required: false + type: string + description: "File_extension" file_name: required: false - type: array + type: string description: "File_name" file_name__empty: required: false @@ -202,43 +222,51 @@ parameters: description: "File_name is empty/null (boolean)" file_name__ic: required: false - type: array + type: string description: "File_name contains (case-insensitive)" file_name__ie: required: false - type: array + type: string description: "File_name exact match (case-insensitive)" file_name__iew: required: false - type: array + type: string description: "File_name ends with (case-insensitive)" + file_name__iregex: + required: false + type: string + description: "File_name" file_name__isw: required: false - type: array + type: string description: "File_name starts with (case-sensitive)" file_name__n: required: false - type: array + type: string description: "File_name not equal to" file_name__nic: required: false - type: array + type: string description: "File_name does not contain (case-insensitive)" file_name__nie: required: false - type: array + type: string description: "File_name inverse exact match (case-insensitive)" file_name__niew: required: false - type: array + type: string description: "File_name does not end with (case-insensitive)" file_name__nisw: required: false - type: array + type: string description: "File_name does not start with (case-sensitive)" + file_name__regex: + required: false + type: string + description: "File_name" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -246,51 +274,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -298,7 +326,7 @@ parameters: description: "Number of results to return per page." mime_type: required: false - type: array + type: string description: "Mime_type" mime_type__empty: required: false @@ -306,47 +334,55 @@ parameters: description: "Mime_type is empty/null (boolean)" mime_type__ic: required: false - type: array + type: string description: "Mime_type contains (case-insensitive)" mime_type__ie: required: false - type: array + type: string description: "Mime_type exact match (case-insensitive)" mime_type__iew: required: false - type: array + type: string description: "Mime_type ends with (case-insensitive)" + mime_type__iregex: + required: false + type: string + description: "Mime_type" mime_type__isw: required: false - type: array + type: string description: "Mime_type starts with (case-sensitive)" mime_type__n: required: false - type: array + type: string description: "Mime_type not equal to" mime_type__nic: required: false - type: array + type: string description: "Mime_type does not contain (case-insensitive)" mime_type__nie: required: false - type: array + type: string description: "Mime_type inverse exact match (case-insensitive)" mime_type__niew: required: false - type: array + type: string description: "Mime_type does not end with (case-insensitive)" mime_type__nisw: required: false - type: array + type: string description: "Mime_type does not start with (case-sensitive)" + mime_type__regex: + required: false + type: string + description: "Mime_type" modified_by_request: required: false type: string description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -354,40 +390,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -396,25 +440,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.extras.custom_field_choice_sets.choices.yaml b/actions/get.extras.custom_field_choice_sets.choices.yaml index 5957058c..4706bdb1 100644 --- a/actions/get.extras.custom_field_choice_sets.choices.yaml +++ b/actions/get.extras.custom_field_choice_sets.choices.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Provides an endpoint to iterate through each choice in a set." enabled: true entry_point: run.py diff --git a/actions/get.extras.custom_field_choice_sets.yaml b/actions/get.extras.custom_field_choice_sets.yaml index 9000b33c..8865bd8d 100644 --- a/actions/get.extras.custom_field_choice_sets.yaml +++ b/actions/get.extras.custom_field_choice_sets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of custom field choice set objects." enabled: true entry_point: run.py @@ -28,37 +28,89 @@ parameters: * `IATA` - IATA (Airport codes) * `ISO_3166` - ISO 3166 (Country codes) * `UN_LOCODE` - UN/LOCODE (Location codes)" + base_choices__empty: + required: false + type: boolean + description: "Base_choices is empty/null (boolean)" + base_choices__ic: + required: false + type: string + description: "Base_choices contains (case-insensitive)" + base_choices__ie: + required: false + type: string + description: "Base_choices exact match (case-insensitive)" + base_choices__iew: + required: false + type: string + description: "Base_choices ends with (case-insensitive)" + base_choices__iregex: + required: false + type: string + description: "Base_choices" + base_choices__isw: + required: false + type: string + description: "Base_choices starts with (case-sensitive)" + base_choices__n: + required: false + type: string + description: "Base_choices not equal to" + base_choices__nic: + required: false + type: string + description: "Base_choices does not contain (case-insensitive)" + base_choices__nie: + required: false + type: string + description: "Base_choices inverse exact match (case-insensitive)" + base_choices__niew: + required: false + type: string + description: "Base_choices does not end with (case-insensitive)" + base_choices__nisw: + required: false + type: string + description: "Base_choices does not start with (case-sensitive)" + base_choices__regex: + required: false + type: string + description: "Base_choices" choice: required: false - type: array + type: string description: "Choice" + choice_colors: + required: false + type: string + description: "Choice colors" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -66,7 +118,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -74,43 +126,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -118,51 +178,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -174,7 +234,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -182,40 +242,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -228,10 +296,46 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string diff --git a/actions/get.extras.custom_fields.yaml b/actions/get.extras.custom_fields.yaml index 43e2798b..61e16dd7 100644 --- a/actions/get.extras.custom_fields.yaml +++ b/actions/get.extras.custom_fields.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of custom field objects." enabled: true entry_point: run.py @@ -22,47 +22,47 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. choice_set: required: false - type: array + type: string description: "Choice_set" choice_set__n: required: false - type: array + type: string description: "Choice_set not equal to" choice_set_id: required: false - type: array + type: integer description: "Choice_set_id" choice_set_id__n: required: false - type: array + type: integer description: "Choice_set_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -70,7 +70,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -78,40 +78,48 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" filter_logic: required: false type: string @@ -120,9 +128,57 @@ parameters: * `disabled` - Disabled * `loose` - Loose * `exact` - Exact" + filter_logic__empty: + required: false + type: boolean + description: "Filter_logic is empty/null (boolean)" + filter_logic__ic: + required: false + type: string + description: "Filter_logic contains (case-insensitive)" + filter_logic__ie: + required: false + type: string + description: "Filter_logic exact match (case-insensitive)" + filter_logic__iew: + required: false + type: string + description: "Filter_logic ends with (case-insensitive)" + filter_logic__iregex: + required: false + type: string + description: "Filter_logic" + filter_logic__isw: + required: false + type: string + description: "Filter_logic starts with (case-sensitive)" + filter_logic__n: + required: false + type: string + description: "Filter_logic not equal to" + filter_logic__nic: + required: false + type: string + description: "Filter_logic does not contain (case-insensitive)" + filter_logic__nie: + required: false + type: string + description: "Filter_logic inverse exact match (case-insensitive)" + filter_logic__niew: + required: false + type: string + description: "Filter_logic does not end with (case-insensitive)" + filter_logic__nisw: + required: false + type: string + description: "Filter_logic does not start with (case-sensitive)" + filter_logic__regex: + required: false + type: string + description: "Filter_logic" group_name: required: false - type: array + type: string description: "Group_name" group_name__empty: required: false @@ -130,43 +186,51 @@ parameters: description: "Group_name is empty/null (boolean)" group_name__ic: required: false - type: array + type: string description: "Group_name contains (case-insensitive)" group_name__ie: required: false - type: array + type: string description: "Group_name exact match (case-insensitive)" group_name__iew: required: false - type: array + type: string description: "Group_name ends with (case-insensitive)" + group_name__iregex: + required: false + type: string + description: "Group_name" group_name__isw: required: false - type: array + type: string description: "Group_name starts with (case-sensitive)" group_name__n: required: false - type: array + type: string description: "Group_name not equal to" group_name__nic: required: false - type: array + type: string description: "Group_name does not contain (case-insensitive)" group_name__nie: required: false - type: array + type: string description: "Group_name inverse exact match (case-insensitive)" group_name__niew: required: false - type: array + type: string description: "Group_name does not end with (case-insensitive)" group_name__nisw: required: false - type: array + type: string description: "Group_name does not start with (case-sensitive)" + group_name__regex: + required: false + type: string + description: "Group_name" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -174,23 +238,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" is_cloneable: required: false @@ -198,7 +262,7 @@ parameters: description: "Is_cloneable" label: required: false - type: array + type: string description: "Label" label__empty: required: false @@ -206,67 +270,75 @@ parameters: description: "Label is empty/null (boolean)" label__ic: required: false - type: array + type: string description: "Label contains (case-insensitive)" label__ie: required: false - type: array + type: string description: "Label exact match (case-insensitive)" label__iew: required: false - type: array + type: string description: "Label ends with (case-insensitive)" + label__iregex: + required: false + type: string + description: "Label" label__isw: required: false - type: array + type: string description: "Label starts with (case-sensitive)" label__n: required: false - type: array + type: string description: "Label not equal to" label__nic: required: false - type: array + type: string description: "Label does not contain (case-insensitive)" label__nie: required: false - type: array + type: string description: "Label inverse exact match (case-insensitive)" label__niew: required: false - type: array + type: string description: "Label does not end with (case-insensitive)" label__nisw: required: false - type: array + type: string description: "Label does not start with (case-sensitive)" + label__regex: + required: false + type: string + description: "Label" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -278,7 +350,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -286,40 +358,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_type: required: false type: string @@ -336,6 +416,10 @@ parameters: required: false type: string description: "Object_type ends with (case-insensitive)" + object_type__iregex: + required: false + type: string + description: "Object_type" object_type__isw: required: false type: string @@ -360,13 +444,17 @@ parameters: required: false type: string description: "Object_type does not start with (case-sensitive)" + object_type__regex: + required: false + type: string + description: "Object_type" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -376,6 +464,38 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string @@ -390,11 +510,11 @@ parameters: description: "Related_object_type not equal to" related_object_type_id: required: false - type: array + type: integer description: "Related_object_type_id" related_object_type_id__n: required: false - type: array + type: integer description: "Related_object_type_id not equal to" required: required: false @@ -402,7 +522,7 @@ parameters: description: "Required" search_weight: required: false - type: array + type: integer description: "Search_weight" search_weight__empty: required: false @@ -410,27 +530,31 @@ parameters: description: "Search_weight is empty/null (boolean)" search_weight__gt: required: false - type: array + type: integer description: "Search_weight greater than" search_weight__gte: required: false - type: array + type: integer description: "Search_weight greater than or equal to" search_weight__lt: required: false - type: array + type: integer description: "Search_weight less than" search_weight__lte: required: false - type: array + type: integer description: "Search_weight less than or equal to" search_weight__n: required: false - type: array + type: integer description: "Search_weight not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." type: required: false - type: array + type: string description: "The type of data this custom field holds" type__empty: required: false @@ -438,40 +562,48 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "The type of data this custom field holds" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "The type of data this custom field holds" ui_editable: required: false type: string @@ -480,6 +612,54 @@ parameters: * `yes` - Yes * `no` - No * `hidden` - Hidden" + ui_editable__empty: + required: false + type: boolean + description: "Ui_editable is empty/null (boolean)" + ui_editable__ic: + required: false + type: string + description: "Ui_editable contains (case-insensitive)" + ui_editable__ie: + required: false + type: string + description: "Ui_editable exact match (case-insensitive)" + ui_editable__iew: + required: false + type: string + description: "Ui_editable ends with (case-insensitive)" + ui_editable__iregex: + required: false + type: string + description: "Ui_editable" + ui_editable__isw: + required: false + type: string + description: "Ui_editable starts with (case-sensitive)" + ui_editable__n: + required: false + type: string + description: "Ui_editable not equal to" + ui_editable__nic: + required: false + type: string + description: "Ui_editable does not contain (case-insensitive)" + ui_editable__nie: + required: false + type: string + description: "Ui_editable inverse exact match (case-insensitive)" + ui_editable__niew: + required: false + type: string + description: "Ui_editable does not end with (case-insensitive)" + ui_editable__nisw: + required: false + type: string + description: "Ui_editable does not start with (case-sensitive)" + ui_editable__regex: + required: false + type: string + description: "Ui_editable" ui_visible: required: false type: string @@ -488,6 +668,54 @@ parameters: * `always` - Always * `if-set` - If set * `hidden` - Hidden" + ui_visible__empty: + required: false + type: boolean + description: "Ui_visible is empty/null (boolean)" + ui_visible__ic: + required: false + type: string + description: "Ui_visible contains (case-insensitive)" + ui_visible__ie: + required: false + type: string + description: "Ui_visible exact match (case-insensitive)" + ui_visible__iew: + required: false + type: string + description: "Ui_visible ends with (case-insensitive)" + ui_visible__iregex: + required: false + type: string + description: "Ui_visible" + ui_visible__isw: + required: false + type: string + description: "Ui_visible starts with (case-sensitive)" + ui_visible__n: + required: false + type: string + description: "Ui_visible not equal to" + ui_visible__nic: + required: false + type: string + description: "Ui_visible does not contain (case-insensitive)" + ui_visible__nie: + required: false + type: string + description: "Ui_visible inverse exact match (case-insensitive)" + ui_visible__niew: + required: false + type: string + description: "Ui_visible does not end with (case-insensitive)" + ui_visible__nisw: + required: false + type: string + description: "Ui_visible does not start with (case-sensitive)" + ui_visible__regex: + required: false + type: string + description: "Ui_visible" unique: required: false type: boolean @@ -498,7 +726,7 @@ parameters: description: "Updated_by_request" validation_maximum: required: false - type: array + type: integer description: "Validation_maximum" validation_maximum__empty: required: false @@ -506,27 +734,27 @@ parameters: description: "Validation_maximum is empty/null (boolean)" validation_maximum__gt: required: false - type: array + type: integer description: "Validation_maximum greater than" validation_maximum__gte: required: false - type: array + type: integer description: "Validation_maximum greater than or equal to" validation_maximum__lt: required: false - type: array + type: integer description: "Validation_maximum less than" validation_maximum__lte: required: false - type: array + type: integer description: "Validation_maximum less than or equal to" validation_maximum__n: required: false - type: array + type: integer description: "Validation_maximum not equal to" validation_minimum: required: false - type: array + type: integer description: "Validation_minimum" validation_minimum__empty: required: false @@ -534,27 +762,27 @@ parameters: description: "Validation_minimum is empty/null (boolean)" validation_minimum__gt: required: false - type: array + type: integer description: "Validation_minimum greater than" validation_minimum__gte: required: false - type: array + type: integer description: "Validation_minimum greater than or equal to" validation_minimum__lt: required: false - type: array + type: integer description: "Validation_minimum less than" validation_minimum__lte: required: false - type: array + type: integer description: "Validation_minimum less than or equal to" validation_minimum__n: required: false - type: array + type: integer description: "Validation_minimum not equal to" validation_regex: required: false - type: array + type: string description: "Validation_regex" validation_regex__empty: required: false @@ -562,43 +790,51 @@ parameters: description: "Validation_regex is empty/null (boolean)" validation_regex__ic: required: false - type: array + type: string description: "Validation_regex contains (case-insensitive)" validation_regex__ie: required: false - type: array + type: string description: "Validation_regex exact match (case-insensitive)" validation_regex__iew: required: false - type: array + type: string description: "Validation_regex ends with (case-insensitive)" + validation_regex__iregex: + required: false + type: string + description: "Validation_regex" validation_regex__isw: required: false - type: array + type: string description: "Validation_regex starts with (case-sensitive)" validation_regex__n: required: false - type: array + type: string description: "Validation_regex not equal to" validation_regex__nic: required: false - type: array + type: string description: "Validation_regex does not contain (case-insensitive)" validation_regex__nie: required: false - type: array + type: string description: "Validation_regex inverse exact match (case-insensitive)" validation_regex__niew: required: false - type: array + type: string description: "Validation_regex does not end with (case-insensitive)" validation_regex__nisw: required: false - type: array + type: string description: "Validation_regex does not start with (case-sensitive)" + validation_regex__regex: + required: false + type: string + description: "Validation_regex" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -606,23 +842,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.custom_links.yaml b/actions/get.extras.custom_links.yaml index 95209bc7..2b1831d4 100644 --- a/actions/get.extras.custom_links.yaml +++ b/actions/get.extras.custom_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of custom link objects." enabled: true entry_point: run.py @@ -40,33 +40,81 @@ parameters: * `black` - Black * `white` - White * `ghost-dark` - Link" + button_class__empty: + required: false + type: boolean + description: "Button_class is empty/null (boolean)" + button_class__ic: + required: false + type: string + description: "Button_class contains (case-insensitive)" + button_class__ie: + required: false + type: string + description: "Button_class exact match (case-insensitive)" + button_class__iew: + required: false + type: string + description: "Button_class ends with (case-insensitive)" + button_class__iregex: + required: false + type: string + description: "Button_class" + button_class__isw: + required: false + type: string + description: "Button_class starts with (case-sensitive)" + button_class__n: + required: false + type: string + description: "Button_class not equal to" + button_class__nic: + required: false + type: string + description: "Button_class does not contain (case-insensitive)" + button_class__nie: + required: false + type: string + description: "Button_class inverse exact match (case-insensitive)" + button_class__niew: + required: false + type: string + description: "Button_class does not end with (case-insensitive)" + button_class__nisw: + required: false + type: string + description: "Button_class does not start with (case-sensitive)" + button_class__regex: + required: false + type: string + description: "Button_class" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +126,7 @@ parameters: description: "Enabled" group_name: required: false - type: array + type: string description: "Group_name" group_name__empty: required: false @@ -86,43 +134,51 @@ parameters: description: "Group_name is empty/null (boolean)" group_name__ic: required: false - type: array + type: string description: "Group_name contains (case-insensitive)" group_name__ie: required: false - type: array + type: string description: "Group_name exact match (case-insensitive)" group_name__iew: required: false - type: array + type: string description: "Group_name ends with (case-insensitive)" + group_name__iregex: + required: false + type: string + description: "Group_name" group_name__isw: required: false - type: array + type: string description: "Group_name starts with (case-sensitive)" group_name__n: required: false - type: array + type: string description: "Group_name not equal to" group_name__nic: required: false - type: array + type: string description: "Group_name does not contain (case-insensitive)" group_name__nie: required: false - type: array + type: string description: "Group_name inverse exact match (case-insensitive)" group_name__niew: required: false - type: array + type: string description: "Group_name does not end with (case-insensitive)" group_name__nisw: required: false - type: array + type: string description: "Group_name does not start with (case-sensitive)" + group_name__regex: + required: false + type: string + description: "Group_name" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -130,51 +186,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -196,6 +252,10 @@ parameters: required: false type: string description: "Link_text ends with (case-insensitive)" + link_text__iregex: + required: false + type: string + description: "Link_text" link_text__isw: required: false type: string @@ -220,6 +280,10 @@ parameters: required: false type: string description: "Link_text does not start with (case-sensitive)" + link_text__regex: + required: false + type: string + description: "Link_text" link_url: required: false type: string @@ -236,6 +300,10 @@ parameters: required: false type: string description: "Link_url ends with (case-insensitive)" + link_url__iregex: + required: false + type: string + description: "Link_url" link_url__isw: required: false type: string @@ -260,13 +328,17 @@ parameters: required: false type: string description: "Link_url does not start with (case-sensitive)" + link_url__regex: + required: false + type: string + description: "Link_url" modified_by_request: required: false type: string description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -274,40 +346,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" new_window: required: false type: boolean @@ -328,6 +408,10 @@ parameters: required: false type: string description: "Object_type ends with (case-insensitive)" + object_type__iregex: + required: false + type: string + description: "Object_type" object_type__isw: required: false type: string @@ -352,13 +436,17 @@ parameters: required: false type: string description: "Object_type does not start with (case-sensitive)" + object_type__regex: + required: false + type: string + description: "Object_type" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -368,17 +456,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -386,23 +510,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.event_rules.yaml b/actions/get.extras.event_rules.yaml index 7581a746..11ea9103 100644 --- a/actions/get.extras.event_rules.yaml +++ b/actions/get.extras.event_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of event rule objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. action_object_id: required: false - type: array + type: integer description: "Action_object_id" action_object_id__empty: required: false - type: array + type: integer description: "Action_object_id is empty/null (boolean)" action_object_id__gt: required: false - type: array + type: integer description: "Action_object_id greater than" action_object_id__gte: required: false - type: array + type: integer description: "Action_object_id greater than or equal to" action_object_id__lt: required: false - type: array + type: integer description: "Action_object_id less than" action_object_id__lte: required: false - type: array + type: integer description: "Action_object_id less than or equal to" action_object_id__n: required: false - type: array + type: integer description: "Action_object_id not equal to" action_object_type: required: false @@ -58,7 +58,7 @@ parameters: description: "Action_object_type not equal to" action_type: required: false - type: array + type: string description: "Action_type" action_type__empty: required: false @@ -66,67 +66,75 @@ parameters: description: "Action_type is empty/null (boolean)" action_type__ic: required: false - type: array + type: string description: "Action_type contains (case-insensitive)" action_type__ie: required: false - type: array + type: string description: "Action_type exact match (case-insensitive)" action_type__iew: required: false - type: array + type: string description: "Action_type ends with (case-insensitive)" + action_type__iregex: + required: false + type: string + description: "Action_type" action_type__isw: required: false - type: array + type: string description: "Action_type starts with (case-sensitive)" action_type__n: required: false - type: array + type: string description: "Action_type not equal to" action_type__nic: required: false - type: array + type: string description: "Action_type does not contain (case-insensitive)" action_type__nie: required: false - type: array + type: string description: "Action_type inverse exact match (case-insensitive)" action_type__niew: required: false - type: array + type: string description: "Action_type does not end with (case-insensitive)" action_type__nisw: required: false - type: array + type: string description: "Action_type does not start with (case-sensitive)" + action_type__regex: + required: false + type: string + description: "Action_type" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -134,7 +142,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -142,51 +150,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" enabled: required: false type: boolean description: "Enabled" event_type: required: false - type: array + type: string description: "Event_type" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -194,51 +210,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -250,7 +266,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -258,40 +274,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_type: required: false type: string @@ -308,6 +332,10 @@ parameters: required: false type: string description: "Object_type ends with (case-insensitive)" + object_type__iregex: + required: false + type: string + description: "Object_type" object_type__isw: required: false type: string @@ -332,13 +360,17 @@ parameters: required: false type: string description: "Object_type does not start with (case-sensitive)" + object_type__regex: + required: false + type: string + description: "Object_type" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -348,25 +380,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.extras.export_templates.yaml b/actions/get.extras.export_templates.yaml index bfe6a5aa..9acaa18e 100644 --- a/actions/get.extras.export_templates.yaml +++ b/actions/get.extras.export_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of export template objects." enabled: true entry_point: run.py @@ -30,31 +30,31 @@ parameters: description: "Auto_sync_enabled" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -62,23 +62,23 @@ parameters: description: "Created_by_request" data_file_id: required: false - type: array + type: integer description: "Data file (ID)" data_file_id__n: required: false - type: array + type: integer description: "Data_file_id not equal to" data_source_id: required: false - type: array + type: integer description: "Data source (ID)" data_source_id__n: required: false - type: array + type: integer description: "Data_source_id not equal to" data_synced: required: false - type: array + type: string description: "Data_synced" data_synced__empty: required: false @@ -86,27 +86,27 @@ parameters: description: "Data_synced is empty/null (boolean)" data_synced__gt: required: false - type: array + type: string description: "Data_synced greater than" data_synced__gte: required: false - type: array + type: string description: "Data_synced greater than or equal to" data_synced__lt: required: false - type: array + type: string description: "Data_synced less than" data_synced__lte: required: false - type: array + type: string description: "Data_synced less than or equal to" data_synced__n: required: false - type: array + type: string description: "Data_synced not equal to" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -114,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" file_extension: required: false - type: array + type: string description: "File_extension" file_extension__empty: required: false @@ -158,43 +166,51 @@ parameters: description: "File_extension is empty/null (boolean)" file_extension__ic: required: false - type: array + type: string description: "File_extension contains (case-insensitive)" file_extension__ie: required: false - type: array + type: string description: "File_extension exact match (case-insensitive)" file_extension__iew: required: false - type: array + type: string description: "File_extension ends with (case-insensitive)" + file_extension__iregex: + required: false + type: string + description: "File_extension" file_extension__isw: required: false - type: array + type: string description: "File_extension starts with (case-sensitive)" file_extension__n: required: false - type: array + type: string description: "File_extension not equal to" file_extension__nic: required: false - type: array + type: string description: "File_extension does not contain (case-insensitive)" file_extension__nie: required: false - type: array + type: string description: "File_extension inverse exact match (case-insensitive)" file_extension__niew: required: false - type: array + type: string description: "File_extension does not end with (case-insensitive)" file_extension__nisw: required: false - type: array + type: string description: "File_extension does not start with (case-sensitive)" + file_extension__regex: + required: false + type: string + description: "File_extension" file_name: required: false - type: array + type: string description: "File_name" file_name__empty: required: false @@ -202,43 +218,51 @@ parameters: description: "File_name is empty/null (boolean)" file_name__ic: required: false - type: array + type: string description: "File_name contains (case-insensitive)" file_name__ie: required: false - type: array + type: string description: "File_name exact match (case-insensitive)" file_name__iew: required: false - type: array + type: string description: "File_name ends with (case-insensitive)" + file_name__iregex: + required: false + type: string + description: "File_name" file_name__isw: required: false - type: array + type: string description: "File_name starts with (case-sensitive)" file_name__n: required: false - type: array + type: string description: "File_name not equal to" file_name__nic: required: false - type: array + type: string description: "File_name does not contain (case-insensitive)" file_name__nie: required: false - type: array + type: string description: "File_name inverse exact match (case-insensitive)" file_name__niew: required: false - type: array + type: string description: "File_name does not end with (case-insensitive)" file_name__nisw: required: false - type: array + type: string description: "File_name does not start with (case-sensitive)" + file_name__regex: + required: false + type: string + description: "File_name" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -246,51 +270,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -298,7 +322,7 @@ parameters: description: "Number of results to return per page." mime_type: required: false - type: array + type: string description: "Mime_type" mime_type__empty: required: false @@ -306,47 +330,55 @@ parameters: description: "Mime_type is empty/null (boolean)" mime_type__ic: required: false - type: array + type: string description: "Mime_type contains (case-insensitive)" mime_type__ie: required: false - type: array + type: string description: "Mime_type exact match (case-insensitive)" mime_type__iew: required: false - type: array + type: string description: "Mime_type ends with (case-insensitive)" + mime_type__iregex: + required: false + type: string + description: "Mime_type" mime_type__isw: required: false - type: array + type: string description: "Mime_type starts with (case-sensitive)" mime_type__n: required: false - type: array + type: string description: "Mime_type not equal to" mime_type__nic: required: false - type: array + type: string description: "Mime_type does not contain (case-insensitive)" mime_type__nie: required: false - type: array + type: string description: "Mime_type inverse exact match (case-insensitive)" mime_type__niew: required: false - type: array + type: string description: "Mime_type does not end with (case-insensitive)" mime_type__nisw: required: false - type: array + type: string description: "Mime_type does not start with (case-sensitive)" + mime_type__regex: + required: false + type: string + description: "Mime_type" modified_by_request: required: false type: string description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -354,40 +386,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_type: required: false type: string @@ -404,6 +444,10 @@ parameters: required: false type: string description: "Object_type ends with (case-insensitive)" + object_type__iregex: + required: false + type: string + description: "Object_type" object_type__isw: required: false type: string @@ -428,13 +472,17 @@ parameters: required: false type: string description: "Object_type does not start with (case-sensitive)" + object_type__regex: + required: false + type: string + description: "Object_type" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -444,10 +492,46 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string diff --git a/actions/get.extras.image_attachments.yaml b/actions/get.extras.image_attachments.yaml index 9a8c5d36..c4ceba42 100644 --- a/actions/get.extras.image_attachments.yaml +++ b/actions/get.extras.image_attachments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of image attachment objects." enabled: true entry_point: run.py @@ -22,39 +22,91 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false type: string description: "Created_by_request" + description: + required: false + type: string + description: "Description" + description__empty: + required: false + type: boolean + description: "Description is empty/null (boolean)" + description__ic: + required: false + type: string + description: "Description contains (case-insensitive)" + description__ie: + required: false + type: string + description: "Description exact match (case-insensitive)" + description__iew: + required: false + type: string + description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" + description__isw: + required: false + type: string + description: "Description starts with (case-sensitive)" + description__n: + required: false + type: string + description: "Description not equal to" + description__nic: + required: false + type: string + description: "Description does not contain (case-insensitive)" + description__nie: + required: false + type: string + description: "Description inverse exact match (case-insensitive)" + description__niew: + required: false + type: string + description: "Description does not end with (case-insensitive)" + description__nisw: + required: false + type: string + description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -62,27 +114,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" image_height: required: false - type: array + type: integer description: "Image_height" image_height__empty: required: false @@ -90,27 +142,27 @@ parameters: description: "Image_height is empty/null (boolean)" image_height__gt: required: false - type: array + type: integer description: "Image_height greater than" image_height__gte: required: false - type: array + type: integer description: "Image_height greater than or equal to" image_height__lt: required: false - type: array + type: integer description: "Image_height less than" image_height__lte: required: false - type: array + type: integer description: "Image_height less than or equal to" image_height__n: required: false - type: array + type: integer description: "Image_height not equal to" image_width: required: false - type: array + type: integer description: "Image_width" image_width__empty: required: false @@ -118,51 +170,51 @@ parameters: description: "Image_width is empty/null (boolean)" image_width__gt: required: false - type: array + type: integer description: "Image_width greater than" image_width__gte: required: false - type: array + type: integer description: "Image_width greater than or equal to" image_width__lt: required: false - type: array + type: integer description: "Image_width less than" image_width__lte: required: false - type: array + type: integer description: "Image_width less than or equal to" image_width__n: required: false - type: array + type: integer description: "Image_width not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -174,7 +226,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -182,43 +234,51 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_id: required: false - type: array + type: integer description: "Object_id" object_id__empty: required: false @@ -226,23 +286,23 @@ parameters: description: "Object_id is empty/null (boolean)" object_id__gt: required: false - type: array + type: integer description: "Object_id greater than" object_id__gte: required: false - type: array + type: integer description: "Object_id greater than or equal to" object_id__lt: required: false - type: array + type: integer description: "Object_id less than" object_id__lte: required: false - type: array + type: integer description: "Object_id less than or equal to" object_id__n: required: false - type: array + type: integer description: "Object_id not equal to" object_type: required: false @@ -272,6 +332,10 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string diff --git a/actions/get.extras.journal_entries.yaml b/actions/get.extras.journal_entries.yaml index 3c1b129d..c65d004a 100644 --- a/actions/get.extras.journal_entries.yaml +++ b/actions/get.extras.journal_entries.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of journal entry objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. assigned_object_id: required: false - type: array + type: integer description: "Assigned_object_id" assigned_object_id__empty: required: false @@ -30,23 +30,23 @@ parameters: description: "Assigned_object_id is empty/null (boolean)" assigned_object_id__gt: required: false - type: array + type: integer description: "Assigned_object_id greater than" assigned_object_id__gte: required: false - type: array + type: integer description: "Assigned_object_id greater than or equal to" assigned_object_id__lt: required: false - type: array + type: integer description: "Assigned_object_id less than" assigned_object_id__lte: required: false - type: array + type: integer description: "Assigned_object_id less than or equal to" assigned_object_id__n: required: false - type: array + type: integer description: "Assigned_object_id not equal to" assigned_object_type: required: false @@ -58,11 +58,11 @@ parameters: description: "Assigned_object_type not equal to" assigned_object_type_id: required: false - type: array + type: integer description: "Assigned_object_type_id" assigned_object_type_id__n: required: false - type: array + type: integer description: "Assigned_object_type_id not equal to" created_after: required: false @@ -74,19 +74,19 @@ parameters: description: "Created_before" created_by: required: false - type: array + type: string description: "User (name)" created_by__n: required: false - type: array + type: string description: "Created_by not equal to" created_by_id: required: false - type: array + type: integer description: "User (ID)" created_by_id__n: required: false - type: array + type: integer description: "Created_by_id not equal to" created_by_request: required: false @@ -94,7 +94,7 @@ parameters: description: "Created_by_request" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -102,27 +102,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" kind: required: false - type: array + type: string description: "Kind" kind__empty: required: false @@ -130,67 +130,75 @@ parameters: description: "Kind is empty/null (boolean)" kind__ic: required: false - type: array + type: string description: "Kind contains (case-insensitive)" kind__ie: required: false - type: array + type: string description: "Kind exact match (case-insensitive)" kind__iew: required: false - type: array + type: string description: "Kind ends with (case-insensitive)" + kind__iregex: + required: false + type: string + description: "Kind" kind__isw: required: false - type: array + type: string description: "Kind starts with (case-sensitive)" kind__n: required: false - type: array + type: string description: "Kind not equal to" kind__nic: required: false - type: array + type: string description: "Kind does not contain (case-insensitive)" kind__nie: required: false - type: array + type: string description: "Kind inverse exact match (case-insensitive)" kind__niew: required: false - type: array + type: string description: "Kind does not end with (case-insensitive)" kind__nisw: required: false - type: array + type: string description: "Kind does not start with (case-sensitive)" + kind__regex: + required: false + type: string + description: "Kind" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -212,21 +220,25 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.extras.notification_groups.yaml b/actions/get.extras.notification_groups.yaml index 391c44b2..d9ab0519 100644 --- a/actions/get.extras.notification_groups.yaml +++ b/actions/get.extras.notification_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of notification group objects." enabled: true entry_point: run.py @@ -32,6 +32,10 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." save_in_key_store: type: boolean default: false diff --git a/actions/get.extras.notifications.yaml b/actions/get.extras.notifications.yaml index 119e779a..7df39d00 100644 --- a/actions/get.extras.notifications.yaml +++ b/actions/get.extras.notifications.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of notification objects." enabled: true entry_point: run.py @@ -32,6 +32,10 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." save_in_key_store: type: boolean default: false diff --git a/actions/get.extras.object_types.yaml b/actions/get.extras.object_types.yaml deleted file mode 100644 index b22e680c..00000000 --- a/actions/get.extras.object_types.yaml +++ /dev/null @@ -1,62 +0,0 @@ -# This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Read-only list of ObjectTypes." -enabled: true -entry_point: run.py -name: get.extras.object_types -parameters: - endpoint_uri: - default: "/extras/object-types/" - immutable: true - type: string - http_verb: - default: get - immutable: true - type: string - get_detail_route_eligible: - default: true - immutable: true - type: boolean - fail_non_2xx: - type: boolean - description: Set action as failed when http return reponse status isn't 2xx. - app_label: - required: false - type: string - description: "App_label" - id: - required: false - type: integer - description: "Id" - limit: - required: false - type: integer - description: "Number of results to return per page." - model: - required: false - type: string - description: "Model" - offset: - required: false - type: integer - description: "The initial index from which to return the results." - ordering: - required: false - type: string - description: "Which field to use when ordering the results." - q: - required: false - type: string - description: "Search" - save_in_key_store: - type: boolean - default: false - description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. - save_in_key_store_key_name: - type: string - description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. - save_in_key_store_ttl: - type: integer - default: 60 - description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. -runner_type: python-script diff --git a/actions/get.extras.saved_filters.yaml b/actions/get.extras.saved_filters.yaml index 85fd6e65..3dc7cdc5 100644 --- a/actions/get.extras.saved_filters.yaml +++ b/actions/get.extras.saved_filters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of saved filter objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,47 +62,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" enabled: required: false type: boolean description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -110,51 +118,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -166,7 +174,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -174,40 +182,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_type: required: false type: string @@ -224,6 +240,10 @@ parameters: required: false type: string description: "Object_type ends with (case-insensitive)" + object_type__iregex: + required: false + type: string + description: "Object_type" object_type__isw: required: false type: string @@ -248,13 +268,17 @@ parameters: required: false type: string description: "Object_type does not start with (case-sensitive)" + object_type__regex: + required: false + type: string + description: "Object_type" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -264,6 +288,38 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string @@ -274,7 +330,7 @@ parameters: description: "Shared" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -282,40 +338,52 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string @@ -326,23 +394,23 @@ parameters: description: "Usable" user: required: false - type: array + type: string description: "User (name)" user__n: required: false - type: array + type: string description: "User not equal to" user_id: required: false - type: array + type: integer description: "User (ID)" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -350,23 +418,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.scripts.yaml b/actions/get.extras.scripts.yaml index 7aadfb61..b7e13a9b 100644 --- a/actions/get.extras.scripts.yaml +++ b/actions/get.extras.scripts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of script objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -30,23 +30,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" is_executable: required: false @@ -58,15 +58,15 @@ parameters: description: "Number of results to return per page." module_id: required: false - type: array + type: integer description: "Script module (ID)" module_id__n: required: false - type: array + type: integer description: "Module_id not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -74,40 +74,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -120,6 +128,10 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." save_in_key_store: type: boolean default: false diff --git a/actions/get.extras.subscriptions.yaml b/actions/get.extras.subscriptions.yaml index cdcafa0b..c797be62 100644 --- a/actions/get.extras.subscriptions.yaml +++ b/actions/get.extras.subscriptions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of subscription objects." enabled: true entry_point: run.py @@ -32,6 +32,10 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." save_in_key_store: type: boolean default: false diff --git a/actions/get.extras.table_configs.yaml b/actions/get.extras.table_configs.yaml index 4055df91..206f14be 100644 --- a/actions/get.extras.table_configs.yaml +++ b/actions/get.extras.table_configs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of table config objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,47 +62,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" enabled: required: false type: boolean description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -110,51 +118,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -166,7 +174,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -174,40 +182,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_type: required: false type: string @@ -218,11 +234,11 @@ parameters: description: "Object_type not equal to" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -240,9 +256,13 @@ parameters: required: false type: boolean description: "Shared" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." table: required: false - type: array + type: string description: "Table" table__empty: required: false @@ -250,40 +270,48 @@ parameters: description: "Table is empty/null (boolean)" table__ic: required: false - type: array + type: string description: "Table contains (case-insensitive)" table__ie: required: false - type: array + type: string description: "Table exact match (case-insensitive)" table__iew: required: false - type: array + type: string description: "Table ends with (case-insensitive)" + table__iregex: + required: false + type: string + description: "Table" table__isw: required: false - type: array + type: string description: "Table starts with (case-sensitive)" table__n: required: false - type: array + type: string description: "Table not equal to" table__nic: required: false - type: array + type: string description: "Table does not contain (case-insensitive)" table__nie: required: false - type: array + type: string description: "Table inverse exact match (case-insensitive)" table__niew: required: false - type: array + type: string description: "Table does not end with (case-insensitive)" table__nisw: required: false - type: array + type: string description: "Table does not start with (case-sensitive)" + table__regex: + required: false + type: string + description: "Table" updated_by_request: required: false type: string @@ -294,23 +322,23 @@ parameters: description: "Usable" user: required: false - type: array + type: string description: "User (name)" user__n: required: false - type: array + type: string description: "User not equal to" user_id: required: false - type: array + type: integer description: "User (ID)" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -318,23 +346,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.tagged_objects.yaml b/actions/get.extras.tagged_objects.yaml index 2d74f038..ff38f1c6 100644 --- a/actions/get.extras.tagged_objects.yaml +++ b/actions/get.extras.tagged_objects.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of tagged item objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -30,23 +30,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" limit: required: false @@ -54,7 +54,7 @@ parameters: description: "Number of results to return per page." object_id: required: false - type: array + type: integer description: "Object_id" object_id__empty: required: false @@ -62,23 +62,23 @@ parameters: description: "Object_id is empty/null (boolean)" object_id__gt: required: false - type: array + type: integer description: "Object_id greater than" object_id__gte: required: false - type: array + type: integer description: "Object_id greater than or equal to" object_id__lt: required: false - type: array + type: integer description: "Object_id less than" object_id__lte: required: false - type: array + type: integer description: "Object_id less than or equal to" object_id__n: required: false - type: array + type: integer description: "Object_id not equal to" object_type: required: false @@ -90,11 +90,11 @@ parameters: description: "Object_type not equal to" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" offset: required: false @@ -108,21 +108,25 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.tags.yaml b/actions/get.extras.tags.yaml index 67c19d05..a4d878d8 100644 --- a/actions/get.extras.tags.yaml +++ b/actions/get.extras.tags.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of tag objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. color: required: false - type: array + type: string description: "Color" color__empty: required: false @@ -30,75 +30,83 @@ parameters: description: "Color is empty/null (boolean)" color__ic: required: false - type: array + type: string description: "Color contains (case-insensitive)" color__ie: required: false - type: array + type: string description: "Color exact match (case-insensitive)" color__iew: required: false - type: array + type: string description: "Color ends with (case-insensitive)" + color__iregex: + required: false + type: string + description: "Color" color__isw: required: false - type: array + type: string description: "Color starts with (case-sensitive)" color__n: required: false - type: array + type: string description: "Color not equal to" color__nic: required: false - type: array + type: string description: "Color does not contain (case-insensitive)" color__nie: required: false - type: array + type: string description: "Color inverse exact match (case-insensitive)" color__niew: required: false - type: array + type: string description: "Color does not end with (case-insensitive)" color__nisw: required: false - type: array + type: string description: "Color does not start with (case-sensitive)" + color__regex: + required: false + type: string + description: "Color" content_type: required: false - type: array + type: string description: "Content_type" content_type_id: required: false - type: array + type: integer description: "Content_type_id" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -106,7 +114,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -114,47 +122,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" for_object_type_id: required: false - type: array + type: integer description: "For_object_type_id" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -162,51 +178,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -218,7 +234,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -226,47 +242,55 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_types: required: false - type: array + type: integer description: "Object_types" object_types__n: required: false - type: array + type: integer description: "Object_types not equal to" offset: required: false @@ -276,13 +300,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -290,47 +346,59 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -338,23 +406,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" save_in_key_store: type: boolean diff --git a/actions/get.extras.webhooks.yaml b/actions/get.extras.webhooks.yaml index f01d331c..03caad73 100644 --- a/actions/get.extras.webhooks.yaml +++ b/actions/get.extras.webhooks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of webhook objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ca_file_path: required: false - type: array + type: string description: "Ca_file_path" ca_file_path__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Ca_file_path is empty/null (boolean)" ca_file_path__ic: required: false - type: array + type: string description: "Ca_file_path contains (case-insensitive)" ca_file_path__ie: required: false - type: array + type: string description: "Ca_file_path exact match (case-insensitive)" ca_file_path__iew: required: false - type: array + type: string description: "Ca_file_path ends with (case-insensitive)" + ca_file_path__iregex: + required: false + type: string + description: "Ca_file_path" ca_file_path__isw: required: false - type: array + type: string description: "Ca_file_path starts with (case-sensitive)" ca_file_path__n: required: false - type: array + type: string description: "Ca_file_path not equal to" ca_file_path__nic: required: false - type: array + type: string description: "Ca_file_path does not contain (case-insensitive)" ca_file_path__nie: required: false - type: array + type: string description: "Ca_file_path inverse exact match (case-insensitive)" ca_file_path__niew: required: false - type: array + type: string description: "Ca_file_path does not end with (case-insensitive)" ca_file_path__nisw: required: false - type: array + type: string description: "Ca_file_path does not start with (case-sensitive)" + ca_file_path__regex: + required: false + type: string + description: "Ca_file_path" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" http_content_type: required: false - type: array + type: string description: "Http_content_type" http_content_type__empty: required: false @@ -150,43 +166,51 @@ parameters: description: "Http_content_type is empty/null (boolean)" http_content_type__ic: required: false - type: array + type: string description: "Http_content_type contains (case-insensitive)" http_content_type__ie: required: false - type: array + type: string description: "Http_content_type exact match (case-insensitive)" http_content_type__iew: required: false - type: array + type: string description: "Http_content_type ends with (case-insensitive)" + http_content_type__iregex: + required: false + type: string + description: "Http_content_type" http_content_type__isw: required: false - type: array + type: string description: "Http_content_type starts with (case-sensitive)" http_content_type__n: required: false - type: array + type: string description: "Http_content_type not equal to" http_content_type__nic: required: false - type: array + type: string description: "Http_content_type does not contain (case-insensitive)" http_content_type__nie: required: false - type: array + type: string description: "Http_content_type inverse exact match (case-insensitive)" http_content_type__niew: required: false - type: array + type: string description: "Http_content_type does not end with (case-insensitive)" http_content_type__nisw: required: false - type: array + type: string description: "Http_content_type does not start with (case-sensitive)" + http_content_type__regex: + required: false + type: string + description: "Http_content_type" http_method: required: false - type: array + type: string description: "Http_method" http_method__empty: required: false @@ -194,43 +218,51 @@ parameters: description: "Http_method is empty/null (boolean)" http_method__ic: required: false - type: array + type: string description: "Http_method contains (case-insensitive)" http_method__ie: required: false - type: array + type: string description: "Http_method exact match (case-insensitive)" http_method__iew: required: false - type: array + type: string description: "Http_method ends with (case-insensitive)" + http_method__iregex: + required: false + type: string + description: "Http_method" http_method__isw: required: false - type: array + type: string description: "Http_method starts with (case-sensitive)" http_method__n: required: false - type: array + type: string description: "Http_method not equal to" http_method__nic: required: false - type: array + type: string description: "Http_method does not contain (case-insensitive)" http_method__nie: required: false - type: array + type: string description: "Http_method inverse exact match (case-insensitive)" http_method__niew: required: false - type: array + type: string description: "Http_method does not end with (case-insensitive)" http_method__nisw: required: false - type: array + type: string description: "Http_method does not start with (case-sensitive)" + http_method__regex: + required: false + type: string + description: "Http_method" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -238,51 +270,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -294,7 +326,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -302,40 +334,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -344,9 +384,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" payload_url: required: false - type: array + type: string description: "Payload_url" q: required: false @@ -354,7 +426,7 @@ parameters: description: "Search" secret: required: false - type: array + type: string description: "Secret" secret__empty: required: false @@ -362,59 +434,71 @@ parameters: description: "Secret is empty/null (boolean)" secret__ic: required: false - type: array + type: string description: "Secret contains (case-insensitive)" secret__ie: required: false - type: array + type: string description: "Secret exact match (case-insensitive)" secret__iew: required: false - type: array + type: string description: "Secret ends with (case-insensitive)" + secret__iregex: + required: false + type: string + description: "Secret" secret__isw: required: false - type: array + type: string description: "Secret starts with (case-sensitive)" secret__n: required: false - type: array + type: string description: "Secret not equal to" secret__nic: required: false - type: array + type: string description: "Secret does not contain (case-insensitive)" secret__nie: required: false - type: array + type: string description: "Secret inverse exact match (case-insensitive)" secret__niew: required: false - type: array + type: string description: "Secret does not end with (case-insensitive)" secret__nisw: required: false - type: array + type: string description: "Secret does not start with (case-sensitive)" + secret__regex: + required: false + type: string + description: "Secret" ssl_verification: required: false type: boolean description: "Ssl_verification" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.aggregates.yaml b/actions/get.ipam.aggregates.yaml index 6956e510..c64ffe95 100644 --- a/actions/get.ipam.aggregates.yaml +++ b/actions/get.ipam.aggregates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of aggregate objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" date_added: required: false - type: array + type: string description: "Date_added" date_added__empty: required: false @@ -86,27 +86,27 @@ parameters: description: "Date_added is empty/null (boolean)" date_added__gt: required: false - type: array + type: string description: "Date_added greater than" date_added__gte: required: false - type: array + type: string description: "Date_added greater than or equal to" date_added__lt: required: false - type: array + type: string description: "Date_added less than" date_added__lte: required: false - type: array + type: string description: "Date_added less than or equal to" date_added__n: required: false - type: array + type: string description: "Date_added not equal to" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -114,47 +114,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" family: required: false type: integer description: "Family" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -162,51 +170,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -224,6 +232,38 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" prefix: required: false type: string @@ -234,67 +274,71 @@ parameters: description: "Search" rir: required: false - type: array + type: string description: "RIR (slug)" rir__n: required: false - type: array + type: string description: "Rir not equal to" rir_id: required: false - type: array + type: integer description: "RIR (ID)" rir_id__n: required: false - type: array + type: integer description: "Rir_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.asn_ranges.available_asns.yaml b/actions/get.ipam.asn_ranges.available_asns.yaml index be0c8362..c07987d1 100644 --- a/actions/get.ipam.asn_ranges.available_asns.yaml +++ b/actions/get.ipam.asn_ranges.available_asns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a ASN object." enabled: true entry_point: run.py diff --git a/actions/get.ipam.asn_ranges.yaml b/actions/get.ipam.asn_ranges.yaml index 0d2ebe1e..1fede418 100644 --- a/actions/get.ipam.asn_ranges.yaml +++ b/actions/get.ipam.asn_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of ASN range objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" end: required: false - type: array + type: integer description: "End" end__empty: required: false @@ -106,27 +114,27 @@ parameters: description: "End is empty/null (boolean)" end__gt: required: false - type: array + type: integer description: "End greater than" end__gte: required: false - type: array + type: integer description: "End greater than or equal to" end__lt: required: false - type: array + type: integer description: "End less than" end__lte: required: false - type: array + type: integer description: "End less than or equal to" end__n: required: false - type: array + type: integer description: "End not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -134,51 +142,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -190,7 +198,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -198,40 +206,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -240,29 +256,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rir: required: false - type: array + type: string description: "RIR (slug)" rir__n: required: false - type: array + type: string description: "Rir not equal to" rir_id: required: false - type: array + type: integer description: "RIR (ID)" rir_id__n: required: false - type: array + type: integer description: "Rir_id not equal to" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -270,115 +318,123 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" start: required: false - type: array - description: "Start" + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." start__empty: required: false type: boolean description: "Start is empty/null (boolean)" start__gt: required: false - type: array + type: integer description: "Start greater than" start__gte: required: false - type: array + type: integer description: "Start greater than or equal to" start__lt: required: false - type: array + type: integer description: "Start less than" start__lte: required: false - type: array + type: integer description: "Start less than or equal to" start__n: required: false - type: array + type: integer description: "Start not equal to" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.asns.yaml b/actions/get.ipam.asns.yaml index c4c75ede..92e1cca1 100644 --- a/actions/get.ipam.asns.yaml +++ b/actions/get.ipam.asns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of ASN objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. asn: required: false - type: array + type: integer description: "Asn" asn__empty: required: false @@ -30,51 +30,51 @@ parameters: description: "Asn is empty/null (boolean)" asn__gt: required: false - type: array + type: integer description: "Asn greater than" asn__gte: required: false - type: array + type: integer description: "Asn greater than or equal to" asn__lt: required: false - type: array + type: integer description: "Asn less than" asn__lte: required: false - type: array + type: integer description: "Asn less than or equal to" asn__n: required: false - type: array + type: integer description: "Asn not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -82,7 +82,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -90,43 +90,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -134,51 +142,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -196,21 +204,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" provider: required: false - type: array + type: string description: "Provider (slug)" provider__n: required: false - type: array + type: string description: "Provider not equal to" provider_id: required: false - type: array + type: integer description: "Provider (ID)" provider_id__n: required: false - type: array + type: integer description: "Provider_id not equal to" q: required: false @@ -218,99 +258,119 @@ parameters: description: "Search" rir: required: false - type: array + type: string description: "RIR (slug)" rir__n: required: false - type: array + type: string description: "Rir not equal to" rir_id: required: false - type: array + type: integer description: "RIR (ID)" rir_id__n: required: false - type: array + type: integer description: "Rir_id not equal to" + role: + required: false + type: string + description: "Role (slug)" + role__n: + required: false + type: string + description: "Role not equal to" + role_id: + required: false + type: integer + description: "Role (ID)" + role_id__n: + required: false + type: integer + description: "Role_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.fhrp_group_assignments.yaml b/actions/get.ipam.fhrp_group_assignments.yaml index a5f8fe42..472e8da1 100644 --- a/actions/get.ipam.fhrp_group_assignments.yaml +++ b/actions/get.ipam.fhrp_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of FHRP group assignment objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,23 +54,23 @@ parameters: description: "Created_by_request" device: required: false - type: array + type: string description: "Device" device_id: required: false - type: array + type: integer description: "Device_id" group_id: required: false - type: array + type: integer description: "Group (ID)" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -78,27 +78,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_id: required: false - type: array + type: integer description: "Interface_id" interface_id__empty: required: false @@ -106,23 +106,23 @@ parameters: description: "Interface_id is empty/null (boolean)" interface_id__gt: required: false - type: array + type: integer description: "Interface_id greater than" interface_id__gte: required: false - type: array + type: integer description: "Interface_id greater than or equal to" interface_id__lt: required: false - type: array + type: integer description: "Interface_id less than" interface_id__lte: required: false - type: array + type: integer description: "Interface_id less than or equal to" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" interface_type: required: false @@ -134,31 +134,31 @@ parameters: description: "Interface_type not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -178,7 +178,7 @@ parameters: description: "Which field to use when ordering the results." priority: required: false - type: array + type: integer description: "Priority" priority__empty: required: false @@ -186,35 +186,39 @@ parameters: description: "Priority is empty/null (boolean)" priority__gt: required: false - type: array + type: integer description: "Priority greater than" priority__gte: required: false - type: array + type: integer description: "Priority greater than or equal to" priority__lt: required: false - type: array + type: integer description: "Priority less than" priority__lte: required: false - type: array + type: integer description: "Priority less than or equal to" priority__n: required: false - type: array + type: integer description: "Priority not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." updated_by_request: required: false type: string description: "Updated_by_request" virtual_machine: required: false - type: array + type: string description: "Virtual_machine" virtual_machine_id: required: false - type: array + type: integer description: "Virtual_machine_id" save_in_key_store: type: boolean diff --git a/actions/get.ipam.fhrp_groups.yaml b/actions/get.ipam.fhrp_groups.yaml index 7a9b8f30..908e254b 100644 --- a/actions/get.ipam.fhrp_groups.yaml +++ b/actions/get.ipam.fhrp_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of FHRP group objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. auth_key: required: false - type: array + type: string description: "Auth_key" auth_key__empty: required: false @@ -30,43 +30,51 @@ parameters: description: "Auth_key is empty/null (boolean)" auth_key__ic: required: false - type: array + type: string description: "Auth_key contains (case-insensitive)" auth_key__ie: required: false - type: array + type: string description: "Auth_key exact match (case-insensitive)" auth_key__iew: required: false - type: array + type: string description: "Auth_key ends with (case-insensitive)" + auth_key__iregex: + required: false + type: string + description: "Auth_key" auth_key__isw: required: false - type: array + type: string description: "Auth_key starts with (case-sensitive)" auth_key__n: required: false - type: array + type: string description: "Auth_key not equal to" auth_key__nic: required: false - type: array + type: string description: "Auth_key does not contain (case-insensitive)" auth_key__nie: required: false - type: array + type: string description: "Auth_key inverse exact match (case-insensitive)" auth_key__niew: required: false - type: array + type: string description: "Auth_key does not end with (case-insensitive)" auth_key__nisw: required: false - type: array + type: string description: "Auth_key does not start with (case-sensitive)" + auth_key__regex: + required: false + type: string + description: "Auth_key" auth_type: required: false - type: array + type: string description: "Auth_type" auth_type__empty: required: false @@ -74,67 +82,75 @@ parameters: description: "Auth_type is empty/null (boolean)" auth_type__ic: required: false - type: array + type: string description: "Auth_type contains (case-insensitive)" auth_type__ie: required: false - type: array + type: string description: "Auth_type exact match (case-insensitive)" auth_type__iew: required: false - type: array + type: string description: "Auth_type ends with (case-insensitive)" + auth_type__iregex: + required: false + type: string + description: "Auth_type" auth_type__isw: required: false - type: array + type: string description: "Auth_type starts with (case-sensitive)" auth_type__n: required: false - type: array + type: string description: "Auth_type not equal to" auth_type__nic: required: false - type: array + type: string description: "Auth_type does not contain (case-insensitive)" auth_type__nie: required: false - type: array + type: string description: "Auth_type inverse exact match (case-insensitive)" auth_type__niew: required: false - type: array + type: string description: "Auth_type does not end with (case-insensitive)" auth_type__nisw: required: false - type: array + type: string description: "Auth_type does not start with (case-sensitive)" + auth_type__regex: + required: false + type: string + description: "Auth_type" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -142,7 +158,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -150,43 +166,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" group_id: required: false - type: array + type: integer description: "Group_id" group_id__empty: required: false @@ -194,27 +218,27 @@ parameters: description: "Group_id is empty/null (boolean)" group_id__gt: required: false - type: array + type: integer description: "Group_id greater than" group_id__gte: required: false - type: array + type: integer description: "Group_id greater than or equal to" group_id__lt: required: false - type: array + type: integer description: "Group_id less than" group_id__lte: required: false - type: array + type: integer description: "Group_id less than or equal to" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -222,51 +246,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -278,7 +302,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -286,40 +310,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -328,9 +360,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" protocol: required: false - type: array + type: string description: "Protocol" protocol__empty: required: false @@ -338,63 +402,75 @@ parameters: description: "Protocol is empty/null (boolean)" protocol__ic: required: false - type: array + type: string description: "Protocol contains (case-insensitive)" protocol__ie: required: false - type: array + type: string description: "Protocol exact match (case-insensitive)" protocol__iew: required: false - type: array + type: string description: "Protocol ends with (case-insensitive)" + protocol__iregex: + required: false + type: string + description: "Protocol" protocol__isw: required: false - type: array + type: string description: "Protocol starts with (case-sensitive)" protocol__n: required: false - type: array + type: string description: "Protocol not equal to" protocol__nic: required: false - type: array + type: string description: "Protocol does not contain (case-insensitive)" protocol__nie: required: false - type: array + type: string description: "Protocol inverse exact match (case-insensitive)" protocol__niew: required: false - type: array + type: string description: "Protocol does not end with (case-insensitive)" protocol__nisw: required: false - type: array + type: string description: "Protocol does not start with (case-sensitive)" + protocol__regex: + required: false + type: string + description: "Protocol" q: required: false type: string description: "Search" related_ip: required: false - type: array + type: string description: "Related_ip" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.ip_addresses.yaml b/actions/get.ipam.ip_addresses.yaml index abb7ee8f..9e967647 100644 --- a/actions/get.ipam.ip_addresses.yaml +++ b/actions/get.ipam.ip_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of IP address objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. address: required: false - type: array + type: string description: "Address" assigned: required: false @@ -30,7 +30,7 @@ parameters: description: "Is assigned" assigned_object_id: required: false - type: array + type: integer description: "Assigned_object_id" assigned_object_id__empty: required: false @@ -38,31 +38,31 @@ parameters: description: "Assigned_object_id is empty/null (boolean)" assigned_object_id__gt: required: false - type: array + type: integer description: "Assigned_object_id greater than" assigned_object_id__gte: required: false - type: array + type: integer description: "Assigned_object_id greater than or equal to" assigned_object_id__lt: required: false - type: array + type: integer description: "Assigned_object_id less than" assigned_object_id__lte: required: false - type: array + type: integer description: "Assigned_object_id less than or equal to" assigned_object_id__n: required: false - type: array + type: integer description: "Assigned_object_id not equal to" assigned_object_type: required: false - type: integer + type: string description: "Assigned_object_type" assigned_object_type__n: required: false - type: integer + type: string description: "Assigned_object_type not equal to" assigned_to_interface: required: false @@ -70,55 +70,55 @@ parameters: description: "Is assigned to an interface" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -126,7 +126,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -134,51 +134,59 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device" device_id: required: false - type: array + type: integer description: "Device_id" dns_name: required: false - type: array + type: string description: "Dns_name" dns_name__empty: required: false @@ -186,55 +194,63 @@ parameters: description: "Dns_name is empty/null (boolean)" dns_name__ic: required: false - type: array + type: string description: "Dns_name contains (case-insensitive)" dns_name__ie: required: false - type: array + type: string description: "Dns_name exact match (case-insensitive)" dns_name__iew: required: false - type: array + type: string description: "Dns_name ends with (case-insensitive)" + dns_name__iregex: + required: false + type: string + description: "Dns_name" dns_name__isw: required: false - type: array + type: string description: "Dns_name starts with (case-sensitive)" dns_name__n: required: false - type: array + type: string description: "Dns_name not equal to" dns_name__nic: required: false - type: array + type: string description: "Dns_name does not contain (case-insensitive)" dns_name__nie: required: false - type: array + type: string description: "Dns_name inverse exact match (case-insensitive)" dns_name__niew: required: false - type: array + type: string description: "Dns_name does not end with (case-insensitive)" dns_name__nisw: required: false - type: array + type: string description: "Dns_name does not start with (case-sensitive)" + dns_name__regex: + required: false + type: string + description: "Dns_name" family: required: false type: integer description: "Family" fhrpgroup_id: required: false - type: array + type: integer description: "FHRP group (ID)" fhrpgroup_id__n: required: false - type: array + type: integer description: "Fhrpgroup_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -242,67 +258,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface: required: false - type: array + type: string description: "Interface (name)" interface__n: required: false - type: array + type: string description: "Interface not equal to" interface_id: required: false - type: array + type: integer description: "Interface (ID)" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -310,7 +326,7 @@ parameters: description: "Number of results to return per page." mask_length: required: false - type: array + type: integer description: "Mask_length" mask_length__gte: required: false @@ -326,11 +342,11 @@ parameters: description: "Modified_by_request" nat_inside_id: required: false - type: array + type: integer description: "NAT inside IP address (ID)" nat_inside_id__n: required: false - type: array + type: integer description: "Nat_inside_id not equal to" offset: required: false @@ -340,9 +356,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent" present_in_vrf: required: false @@ -358,7 +406,7 @@ parameters: description: "Search" role: required: false - type: array + type: string description: "The functional role of this IP" role__empty: required: false @@ -366,51 +414,63 @@ parameters: description: "Role is empty/null (boolean)" role__ic: required: false - type: array + type: string description: "Role contains (case-insensitive)" role__ie: required: false - type: array + type: string description: "Role exact match (case-insensitive)" role__iew: required: false - type: array + type: string description: "Role ends with (case-insensitive)" + role__iregex: + required: false + type: string + description: "The functional role of this IP" role__isw: required: false - type: array + type: string description: "Role starts with (case-sensitive)" role__n: required: false - type: array + type: string description: "Role not equal to" role__nic: required: false - type: array + type: string description: "Role does not contain (case-insensitive)" role__nie: required: false - type: array + type: string description: "Role inverse exact match (case-insensitive)" role__niew: required: false - type: array + type: string description: "Role does not end with (case-insensitive)" role__nisw: required: false - type: array + type: string description: "Role does not start with (case-sensitive)" + role__regex: + required: false + type: string + description: "The functional role of this IP" service_id: required: false - type: array - description: "Service (ID)" + type: integer + description: "Application Service (ID)" service_id__n: required: false - type: array + type: integer description: "Service_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "The operational status of this IP" status__empty: required: false @@ -418,87 +478,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "The operational status of this IP" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "The operational status of this IP" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -506,43 +574,43 @@ parameters: description: "Updated_by_request" virtual_machine: required: false - type: array + type: string description: "Virtual_machine" virtual_machine_id: required: false - type: array + type: integer description: "Virtual_machine_id" vminterface: required: false - type: array + type: string description: "VM interface (name)" vminterface__n: required: false - type: array + type: string description: "Vminterface not equal to" vminterface_id: required: false - type: array + type: integer description: "VM interface (ID)" vminterface_id__n: required: false - type: array + type: integer description: "Vminterface_id not equal to" vrf: required: false - type: array + type: string description: "VRF (RD)" vrf__n: required: false - type: array + type: string description: "Vrf not equal to" vrf_id: required: false - type: array + type: integer description: "VRF" vrf_id__n: required: false - type: array + type: integer description: "Vrf_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.ipam.ip_ranges.available_ips.yaml b/actions/get.ipam.ip_ranges.available_ips.yaml index 4b31904a..f144afcc 100644 --- a/actions/get.ipam.ip_ranges.available_ips.yaml +++ b/actions/get.ipam.ip_ranges.available_ips.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a IP address object." enabled: true entry_point: run.py diff --git a/actions/get.ipam.ip_ranges.yaml b/actions/get.ipam.ip_ranges.yaml index bd9602b0..1e1aedef 100644 --- a/actions/get.ipam.ip_ranges.yaml +++ b/actions/get.ipam.ip_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of IP range objects." enabled: true entry_point: run.py @@ -22,27 +22,27 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" contains: required: false @@ -50,31 +50,31 @@ parameters: description: "Ranges which contain this prefix or IP" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -82,7 +82,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -90,43 +90,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" end_address: required: false - type: array + type: string description: "End_address" family: required: false @@ -134,7 +142,7 @@ parameters: description: "Family" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -142,51 +150,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -212,9 +220,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent" q: required: false @@ -222,23 +262,23 @@ parameters: description: "Search" role: required: false - type: array + type: string description: "Role (slug)" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: integer description: "Role (ID)" role_id__n: required: false - type: array + type: integer description: "Role_id not equal to" size: required: false - type: array + type: integer description: "Size" size__empty: required: false @@ -246,31 +286,35 @@ parameters: description: "Size is empty/null (boolean)" size__gt: required: false - type: array + type: integer description: "Size greater than" size__gte: required: false - type: array + type: integer description: "Size greater than or equal to" size__lt: required: false - type: array + type: integer description: "Size less than" size__lte: required: false - type: array + type: integer description: "Size less than or equal to" size__n: required: false - type: array + type: integer description: "Size not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." start_address: required: false - type: array + type: string description: "Start_address" status: required: false - type: array + type: string description: "Operational status of this range" status__empty: required: false @@ -278,87 +322,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Operational status of this range" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Operational status of this range" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -366,19 +418,19 @@ parameters: description: "Updated_by_request" vrf: required: false - type: array + type: string description: "VRF (RD)" vrf__n: required: false - type: array + type: string description: "Vrf not equal to" vrf_id: required: false - type: array + type: integer description: "VRF" vrf_id__n: required: false - type: array + type: integer description: "Vrf_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.ipam.prefixes.available_ips.yaml b/actions/get.ipam.prefixes.available_ips.yaml index 501a54e4..1f74efca 100644 --- a/actions/get.ipam.prefixes.available_ips.yaml +++ b/actions/get.ipam.prefixes.available_ips.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a IP address object." enabled: true entry_point: run.py diff --git a/actions/get.ipam.prefixes.available_prefixes.yaml b/actions/get.ipam.prefixes.available_prefixes.yaml index 9de0c32b..64c16cd2 100644 --- a/actions/get.ipam.prefixes.available_prefixes.yaml +++ b/actions/get.ipam.prefixes.available_prefixes.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a prefix object." enabled: true entry_point: run.py diff --git a/actions/get.ipam.prefixes.yaml b/actions/get.ipam.prefixes.yaml index fb461de3..e67453fc 100644 --- a/actions/get.ipam.prefixes.yaml +++ b/actions/get.ipam.prefixes.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of prefix objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. children: required: false - type: array + type: integer description: "Children" children__empty: required: false - type: array + type: integer description: "Children is empty/null (boolean)" children__gt: required: false - type: array + type: integer description: "Children greater than" children__gte: required: false - type: array + type: integer description: "Children greater than or equal to" children__lt: required: false - type: array + type: integer description: "Children less than" children__lte: required: false - type: array + type: integer description: "Children less than or equal to" children__n: required: false - type: array + type: integer description: "Children not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" contains: required: false @@ -78,31 +78,31 @@ parameters: description: "Prefixes which contain this prefix or IP" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -110,35 +110,35 @@ parameters: description: "Created_by_request" depth: required: false - type: array + type: integer description: "Depth" depth__empty: required: false - type: array + type: integer description: "Depth is empty/null (boolean)" depth__gt: required: false - type: array + type: integer description: "Depth greater than" depth__gte: required: false - type: array + type: integer description: "Depth greater than or equal to" depth__lt: required: false - type: array + type: integer description: "Depth less than" depth__lte: required: false - type: array + type: integer description: "Depth less than or equal to" depth__n: required: false - type: array + type: integer description: "Depth not equal to" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -146,47 +146,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" family: required: false type: integer description: "Family" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -194,23 +202,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" is_pool: required: false @@ -218,31 +226,31 @@ parameters: description: "Is_pool" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -250,19 +258,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" mark_utilized: required: false @@ -270,7 +278,7 @@ parameters: description: "Mark_utilized" mask_length: required: false - type: array + type: integer description: "Mask_length" mask_length__gte: required: false @@ -292,9 +300,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" prefix: required: false - type: array + type: string description: "Prefix" present_in_vrf: required: false @@ -310,39 +350,39 @@ parameters: description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" role: required: false - type: array + type: string description: "Role (slug)" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: integer description: "Role (ID)" role_id__n: required: false - type: array + type: integer description: "Role_id not equal to" scope_id: required: false - type: array + type: integer description: "Scope_id" scope_id__empty: required: false @@ -350,23 +390,23 @@ parameters: description: "Scope_id is empty/null (boolean)" scope_id__gt: required: false - type: array + type: integer description: "Scope_id greater than" scope_id__gte: required: false - type: array + type: integer description: "Scope_id greater than or equal to" scope_id__lt: required: false - type: array + type: integer description: "Scope_id less than" scope_id__lte: required: false - type: array + type: integer description: "Scope_id less than or equal to" scope_id__n: required: false - type: array + type: integer description: "Scope_id not equal to" scope_type: required: false @@ -378,39 +418,43 @@ parameters: description: "Scope_type not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Operational status of this prefix" status__empty: required: false @@ -418,87 +462,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Operational status of this prefix" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Operational status of this prefix" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -506,27 +558,27 @@ parameters: description: "Updated_by_request" vlan_group: required: false - type: array + type: string description: "VLAN Group (slug)" vlan_group__n: required: false - type: array + type: string description: "Vlan_group not equal to" vlan_group_id: required: false - type: array + type: integer description: "VLAN Group (ID)" vlan_group_id__n: required: false - type: array + type: integer description: "Vlan_group_id not equal to" vlan_id: required: false - type: array + type: integer description: "VLAN (ID)" vlan_id__n: required: false - type: array + type: integer description: "Vlan_id not equal to" vlan_vid: required: false @@ -558,19 +610,19 @@ parameters: description: "Vlan_vid not equal to" vrf: required: false - type: array + type: string description: "VRF (RD)" vrf__n: required: false - type: array + type: string description: "Vrf not equal to" vrf_id: required: false - type: array + type: integer description: "VRF" vrf_id__n: required: false - type: array + type: integer description: "Vrf_id not equal to" within: required: false diff --git a/actions/get.ipam.rirs.yaml b/actions/get.ipam.rirs.yaml index 052f1eea..8364fd9b 100644 --- a/actions/get.ipam.rirs.yaml +++ b/actions/get.ipam.rirs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of RIR objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,23 +114,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" is_private: required: false @@ -130,31 +138,31 @@ parameters: description: "Is_private" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -166,7 +174,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -174,40 +182,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -216,13 +232,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -230,55 +278,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.roles.yaml b/actions/get.ipam.roles.yaml index d6084482..084c8642 100644 --- a/actions/get.ipam.roles.yaml +++ b/actions/get.ipam.roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of role objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,13 +228,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -226,55 +274,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -282,7 +342,7 @@ parameters: description: "Updated_by_request" weight: required: false - type: array + type: integer description: "Weight" weight__empty: required: false @@ -290,23 +350,23 @@ parameters: description: "Weight is empty/null (boolean)" weight__gt: required: false - type: array + type: integer description: "Weight greater than" weight__gte: required: false - type: array + type: integer description: "Weight greater than or equal to" weight__lt: required: false - type: array + type: integer description: "Weight less than" weight__lte: required: false - type: array + type: integer description: "Weight less than or equal to" weight__n: required: false - type: array + type: integer description: "Weight not equal to" save_in_key_store: type: boolean diff --git a/actions/get.ipam.route_targets.yaml b/actions/get.ipam.route_targets.yaml index 1e7f61c0..da989d70 100644 --- a/actions/get.ipam.route_targets.yaml +++ b/actions/get.ipam.route_targets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of route target objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,75 +62,83 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" exporting_l2vpn: required: false - type: array + type: integer description: "Exporting L2VPN (identifier)" exporting_l2vpn__n: required: false - type: array + type: integer description: "Exporting_l2vpn not equal to" exporting_l2vpn_id: required: false - type: array + type: integer description: "Exporting L2VPN" exporting_l2vpn_id__n: required: false - type: array + type: integer description: "Exporting_l2vpn_id not equal to" exporting_vrf: required: false - type: array + type: string description: "Export VRF (RD)" exporting_vrf__n: required: false - type: array + type: string description: "Exporting_vrf not equal to" exporting_vrf_id: required: false - type: array + type: integer description: "Exporting VRF" exporting_vrf_id__n: required: false - type: array + type: integer description: "Exporting_vrf_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -138,83 +146,83 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" importing_l2vpn: required: false - type: array + type: integer description: "Importing L2VPN (identifier)" importing_l2vpn__n: required: false - type: array + type: integer description: "Importing_l2vpn not equal to" importing_l2vpn_id: required: false - type: array + type: integer description: "Importing L2VPN" importing_l2vpn_id__n: required: false - type: array + type: integer description: "Importing_l2vpn_id not equal to" importing_vrf: required: false - type: array + type: string description: "Import VRF (RD)" importing_vrf__n: required: false - type: array + type: string description: "Importing_vrf not equal to" importing_vrf_id: required: false - type: array + type: integer description: "Importing VRF" importing_vrf_id__n: required: false - type: array + type: integer description: "Importing_vrf_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -226,7 +234,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -234,40 +242,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -276,57 +292,93 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.service_templates.yaml b/actions/get.ipam.service_templates.yaml index 6d01c371..e94054ca 100644 --- a/actions/get.ipam.service_templates.yaml +++ b/actions/get.ipam.service_templates.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Get a list of service template objects." +# NetBox API version: 4.6 +description: "Get a list of application service template objects." enabled: true entry_point: run.py name: get.ipam.service_templates @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,35 +228,143 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" port: required: false type: integer description: "Port" + port__empty: + required: false + type: integer + description: "Port is empty/null (boolean)" + port__gt: + required: false + type: integer + description: "Port greater than" + port__gte: + required: false + type: integer + description: "Port greater than or equal to" + port__lt: + required: false + type: integer + description: "Port less than" + port__lte: + required: false + type: integer + description: "Port less than or equal to" + port__n: + required: false + type: integer + description: "Port not equal to" protocol: required: false type: string description: "* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP" + protocol__empty: + required: false + type: boolean + description: "Protocol is empty/null (boolean)" + protocol__ic: + required: false + type: string + description: "Protocol contains (case-insensitive)" + protocol__ie: + required: false + type: string + description: "Protocol exact match (case-insensitive)" + protocol__iew: + required: false + type: string + description: "Protocol ends with (case-insensitive)" + protocol__iregex: + required: false + type: string + description: "Protocol" + protocol__isw: + required: false + type: string + description: "Protocol starts with (case-sensitive)" + protocol__n: + required: false + type: string + description: "Protocol not equal to" + protocol__nic: + required: false + type: string + description: "Protocol does not contain (case-insensitive)" + protocol__nie: + required: false + type: string + description: "Protocol inverse exact match (case-insensitive)" + protocol__niew: + required: false + type: string + description: "Protocol does not end with (case-insensitive)" + protocol__nisw: + required: false + type: string + description: "Protocol does not start with (case-sensitive)" + protocol__regex: + required: false + type: string + description: "Protocol" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.services.yaml b/actions/get.ipam.services.yaml index 4859cfa5..c401d509 100644 --- a/actions/get.ipam.services.yaml +++ b/actions/get.ipam.services.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Get a list of service objects." +# NetBox API version: 4.6 +description: "Get a list of application service objects." enabled: true entry_point: run.py name: get.ipam.services @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,59 +86,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device" device_id: required: false - type: array + type: integer description: "Device_id" fhrpgroup: required: false - type: array + type: string description: "Fhrpgroup" fhrpgroup_id: required: false - type: array + type: integer description: "Fhrpgroup_id" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -146,67 +154,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" ip_address: required: false - type: array + type: string description: "IP address" ip_address__n: required: false - type: array + type: string description: "Ip_address not equal to" ip_address_id: required: false - type: array + type: integer description: "IP address (ID)" ip_address_id__n: required: false - type: array + type: integer description: "Ip_address_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -218,7 +226,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -226,40 +234,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -268,9 +284,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent_object_id: required: false - type: array + type: integer description: "Parent_object_id" parent_object_id__empty: required: false @@ -278,61 +326,137 @@ parameters: description: "Parent_object_id is empty/null (boolean)" parent_object_id__gt: required: false - type: array + type: integer description: "Parent_object_id greater than" parent_object_id__gte: required: false - type: array + type: integer description: "Parent_object_id greater than or equal to" parent_object_id__lt: required: false - type: array + type: integer description: "Parent_object_id less than" parent_object_id__lte: required: false - type: array + type: integer description: "Parent_object_id less than or equal to" parent_object_id__n: required: false - type: array + type: integer description: "Parent_object_id not equal to" parent_object_type: required: false - type: integer + type: string description: "Parent_object_type" parent_object_type__n: required: false - type: integer + type: string description: "Parent_object_type not equal to" port: required: false type: integer description: "Port" + port__empty: + required: false + type: integer + description: "Port is empty/null (boolean)" + port__gt: + required: false + type: integer + description: "Port greater than" + port__gte: + required: false + type: integer + description: "Port greater than or equal to" + port__lt: + required: false + type: integer + description: "Port less than" + port__lte: + required: false + type: integer + description: "Port less than or equal to" + port__n: + required: false + type: integer + description: "Port not equal to" protocol: required: false type: string description: "* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP" + protocol__empty: + required: false + type: boolean + description: "Protocol is empty/null (boolean)" + protocol__ic: + required: false + type: string + description: "Protocol contains (case-insensitive)" + protocol__ie: + required: false + type: string + description: "Protocol exact match (case-insensitive)" + protocol__iew: + required: false + type: string + description: "Protocol ends with (case-insensitive)" + protocol__iregex: + required: false + type: string + description: "Protocol" + protocol__isw: + required: false + type: string + description: "Protocol starts with (case-sensitive)" + protocol__n: + required: false + type: string + description: "Protocol not equal to" + protocol__nic: + required: false + type: string + description: "Protocol does not contain (case-insensitive)" + protocol__nie: + required: false + type: string + description: "Protocol inverse exact match (case-insensitive)" + protocol__niew: + required: false + type: string + description: "Protocol does not end with (case-insensitive)" + protocol__nisw: + required: false + type: string + description: "Protocol does not start with (case-sensitive)" + protocol__regex: + required: false + type: string + description: "Protocol" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -340,11 +464,11 @@ parameters: description: "Updated_by_request" virtual_machine: required: false - type: array + type: string description: "Virtual_machine" virtual_machine_id: required: false - type: array + type: integer description: "Virtual_machine_id" save_in_key_store: type: boolean diff --git a/actions/get.ipam.vlan_groups.available_vlans.yaml b/actions/get.ipam.vlan_groups.available_vlans.yaml index cabc3d56..8df5d848 100644 --- a/actions/get.ipam.vlan_groups.available_vlans.yaml +++ b/actions/get.ipam.vlan_groups.available_vlans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a VLAN object." enabled: true entry_point: run.py diff --git a/actions/get.ipam.vlan_groups.yaml b/actions/get.ipam.vlan_groups.yaml index 9d731a7d..22a40793 100644 --- a/actions/get.ipam.vlan_groups.yaml +++ b/actions/get.ipam.vlan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of VLAN group objects." enabled: true entry_point: run.py @@ -34,31 +34,31 @@ parameters: description: "Contains_vid" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -66,7 +66,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -74,43 +74,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -118,51 +126,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -178,7 +186,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -186,40 +194,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -228,6 +244,38 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string @@ -236,13 +284,17 @@ parameters: required: false type: integer description: "Rack" + rack_group: + required: false + type: integer + description: "Rack_group" region: required: false type: integer description: "Region" scope_id: required: false - type: array + type: integer description: "Scope_id" scope_id__empty: required: false @@ -250,23 +302,23 @@ parameters: description: "Scope_id is empty/null (boolean)" scope_id__gt: required: false - type: array + type: integer description: "Scope_id greater than" scope_id__gte: required: false - type: array + type: integer description: "Scope_id greater than or equal to" scope_id__lt: required: false - type: array + type: integer description: "Scope_id less than" scope_id__lte: required: false - type: array + type: integer description: "Scope_id less than or equal to" scope_id__n: required: false - type: array + type: integer description: "Scope_id not equal to" scope_type: required: false @@ -286,7 +338,7 @@ parameters: description: "Site_group" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -294,88 +346,128 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" + total_vlan_ids: + required: false + type: integer + description: "Total_vlan_ids" + total_vlan_ids__empty: + required: false + type: boolean + description: "Total_vlan_ids is empty/null (boolean)" + total_vlan_ids__gt: + required: false + type: integer + description: "Total_vlan_ids greater than" + total_vlan_ids__gte: + required: false + type: integer + description: "Total_vlan_ids greater than or equal to" + total_vlan_ids__lt: + required: false + type: integer + description: "Total_vlan_ids less than" + total_vlan_ids__lte: + required: false + type: integer + description: "Total_vlan_ids less than or equal to" + total_vlan_ids__n: + required: false + type: integer + description: "Total_vlan_ids not equal to" updated_by_request: required: false type: string diff --git a/actions/get.ipam.vlan_translation_policies.yaml b/actions/get.ipam.vlan_translation_policies.yaml index 65c7a674..16058b07 100644 --- a/actions/get.ipam.vlan_translation_policies.yaml +++ b/actions/get.ipam.vlan_translation_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of VLAN translation policy objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,25 +228,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.vlan_translation_rules.yaml b/actions/get.ipam.vlan_translation_rules.yaml index 6a303e39..f173e5ea 100644 --- a/actions/get.ipam.vlan_translation_rules.yaml +++ b/actions/get.ipam.vlan_translation_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of VLAN translation rule objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -158,7 +166,7 @@ parameters: description: "Number of results to return per page." local_vid: required: false - type: array + type: integer description: "Local_vid" local_vid__empty: required: false @@ -166,23 +174,23 @@ parameters: description: "Local_vid is empty/null (boolean)" local_vid__gt: required: false - type: array + type: integer description: "Local_vid greater than" local_vid__gte: required: false - type: array + type: integer description: "Local_vid greater than or equal to" local_vid__lt: required: false - type: array + type: integer description: "Local_vid less than" local_vid__lte: required: false - type: array + type: integer description: "Local_vid less than or equal to" local_vid__n: required: false - type: array + type: integer description: "Local_vid not equal to" modified_by_request: required: false @@ -198,19 +206,19 @@ parameters: description: "Which field to use when ordering the results." policy: required: false - type: array + type: string description: "VLAN Translation Policy (name)" policy__n: required: false - type: array + type: string description: "Policy not equal to" policy_id: required: false - type: array + type: integer description: "VLAN Translation Policy (ID)" policy_id__n: required: false - type: array + type: integer description: "Policy_id not equal to" q: required: false @@ -218,7 +226,7 @@ parameters: description: "Search" remote_vid: required: false - type: array + type: integer description: "Remote_vid" remote_vid__empty: required: false @@ -226,39 +234,43 @@ parameters: description: "Remote_vid is empty/null (boolean)" remote_vid__gt: required: false - type: array + type: integer description: "Remote_vid greater than" remote_vid__gte: required: false - type: array + type: integer description: "Remote_vid greater than or equal to" remote_vid__lt: required: false - type: array + type: integer description: "Remote_vid less than" remote_vid__lte: required: false - type: array + type: integer description: "Remote_vid less than or equal to" remote_vid__n: required: false - type: array + type: integer description: "Remote_vid not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.ipam.vlans.yaml b/actions/get.ipam.vlans.yaml index 00187d32..7c5afef3 100644 --- a/actions/get.ipam.vlans.yaml +++ b/actions/get.ipam.vlans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of VLAN objects." enabled: true entry_point: run.py @@ -34,31 +34,31 @@ parameters: description: "Available_on_virtualmachine" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -66,7 +66,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -74,59 +74,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" group: required: false - type: array + type: string description: "Group" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: integer description: "Group (ID)" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -134,71 +142,71 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_id: required: false - type: string - description: "Assigned interface" + type: integer + description: "Interface_id" l2vpn: required: false - type: array + type: integer description: "L2VPN" l2vpn__n: required: false - type: array + type: integer description: "L2vpn not equal to" l2vpn_id: required: false - type: array + type: integer description: "L2VPN (ID)" l2vpn_id__n: required: false - type: array + type: integer description: "L2vpn_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -210,7 +218,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -218,40 +226,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -260,13 +276,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" qinq_role: required: false - type: array + type: string description: "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" qinq_role__empty: required: false @@ -274,143 +322,155 @@ parameters: description: "Qinq_role is empty/null (boolean)" qinq_role__ic: required: false - type: array + type: string description: "Qinq_role contains (case-insensitive)" qinq_role__ie: required: false - type: array + type: string description: "Qinq_role exact match (case-insensitive)" qinq_role__iew: required: false - type: array + type: string description: "Qinq_role ends with (case-insensitive)" + qinq_role__iregex: + required: false + type: string + description: "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" qinq_role__isw: required: false - type: array + type: string description: "Qinq_role starts with (case-sensitive)" qinq_role__n: required: false - type: array + type: string description: "Qinq_role not equal to" qinq_role__nic: required: false - type: array + type: string description: "Qinq_role does not contain (case-insensitive)" qinq_role__nie: required: false - type: array + type: string description: "Qinq_role inverse exact match (case-insensitive)" qinq_role__niew: required: false - type: array + type: string description: "Qinq_role does not end with (case-insensitive)" qinq_role__nisw: required: false - type: array + type: string description: "Qinq_role does not start with (case-sensitive)" + qinq_role__regex: + required: false + type: string + description: "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" qinq_svlan_id: required: false - type: array + type: integer description: "Q-in-Q SVLAN (ID)" qinq_svlan_id__n: required: false - type: array + type: integer description: "Qinq_svlan_id not equal to" qinq_svlan_vid: required: false - type: array + type: integer description: "Qinq_svlan_vid" qinq_svlan_vid__empty: required: false - type: array + type: integer description: "Qinq_svlan_vid is empty/null (boolean)" qinq_svlan_vid__gt: required: false - type: array + type: integer description: "Qinq_svlan_vid greater than" qinq_svlan_vid__gte: required: false - type: array + type: integer description: "Qinq_svlan_vid greater than or equal to" qinq_svlan_vid__lt: required: false - type: array + type: integer description: "Qinq_svlan_vid less than" qinq_svlan_vid__lte: required: false - type: array + type: integer description: "Qinq_svlan_vid less than or equal to" qinq_svlan_vid__n: required: false - type: array + type: integer description: "Qinq_svlan_vid not equal to" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" role: required: false - type: array + type: string description: "Role (slug)" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: integer description: "Role (ID)" role_id__n: required: false - type: array + type: integer description: "Role_id not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Operational status of this VLAN" status__empty: required: false @@ -418,87 +478,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Operational status of this VLAN" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Operational status of this VLAN" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -506,7 +574,7 @@ parameters: description: "Updated_by_request" vid: required: false - type: array + type: integer description: "Vid" vid__empty: required: false @@ -514,28 +582,28 @@ parameters: description: "Vid is empty/null (boolean)" vid__gt: required: false - type: array + type: integer description: "Vid greater than" vid__gte: required: false - type: array + type: integer description: "Vid greater than or equal to" vid__lt: required: false - type: array + type: integer description: "Vid less than" vid__lte: required: false - type: array + type: integer description: "Vid less than or equal to" vid__n: required: false - type: array + type: integer description: "Vid not equal to" vminterface_id: required: false - type: string - description: "Assigned VM interface" + type: integer + description: "Vminterface_id" save_in_key_store: type: boolean default: false diff --git a/actions/get.ipam.vrfs.yaml b/actions/get.ipam.vrfs.yaml index 8dae71fb..6a2d93ef 100644 --- a/actions/get.ipam.vrfs.yaml +++ b/actions/get.ipam.vrfs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of VRF objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,63 +62,71 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" enforce_unique: required: false type: boolean description: "Enforce_unique" export_target: required: false - type: array + type: string description: "Export target (name)" export_target__n: required: false - type: array + type: string description: "Export_target not equal to" export_target_id: required: false - type: array + type: integer description: "Export target" export_target_id__n: required: false - type: array + type: integer description: "Export_target_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -126,67 +134,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" import_target: required: false - type: array + type: string description: "Import target (name)" import_target__n: required: false - type: array + type: string description: "Import_target not equal to" import_target_id: required: false - type: array + type: integer description: "Import target" import_target_id__n: required: false - type: array + type: integer description: "Import_target_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -198,7 +206,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -206,40 +214,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -248,13 +264,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" rd: required: false - type: array + type: string description: "Rd" rd__empty: required: false @@ -262,87 +310,99 @@ parameters: description: "Rd is empty/null (boolean)" rd__ic: required: false - type: array + type: string description: "Rd contains (case-insensitive)" rd__ie: required: false - type: array + type: string description: "Rd exact match (case-insensitive)" rd__iew: required: false - type: array + type: string description: "Rd ends with (case-insensitive)" + rd__iregex: + required: false + type: string + description: "Rd" rd__isw: required: false - type: array + type: string description: "Rd starts with (case-sensitive)" rd__n: required: false - type: array + type: string description: "Rd not equal to" rd__nic: required: false - type: array + type: string description: "Rd does not contain (case-insensitive)" rd__nie: required: false - type: array + type: string description: "Rd inverse exact match (case-insensitive)" rd__niew: required: false - type: array + type: string description: "Rd does not end with (case-insensitive)" rd__nisw: required: false - type: array + type: string description: "Rd does not start with (case-sensitive)" + rd__regex: + required: false + type: string + description: "Rd" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/get.tenancy.contact_assignments.yaml b/actions/get.tenancy.contact_assignments.yaml index bdac88d8..9aba2f1b 100644 --- a/actions/get.tenancy.contact_assignments.yaml +++ b/actions/get.tenancy.contact_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of contact assignment objects." enabled: true entry_point: run.py @@ -22,39 +22,39 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact_id: required: false - type: array + type: integer description: "Contact (ID)" contact_id__n: required: false - type: array + type: integer description: "Contact_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -62,23 +62,23 @@ parameters: description: "Created_by_request" group: required: false - type: array + type: string description: "Group" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: string description: "Group_id" group_id__n: required: false - type: array + type: string description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -86,51 +86,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -142,7 +142,7 @@ parameters: description: "Modified_by_request" object_id: required: false - type: array + type: integer description: "Object_id" object_id__empty: required: false @@ -150,23 +150,23 @@ parameters: description: "Object_id is empty/null (boolean)" object_id__gt: required: false - type: array + type: integer description: "Object_id greater than" object_id__gte: required: false - type: array + type: integer description: "Object_id greater than or equal to" object_id__lt: required: false - type: array + type: integer description: "Object_id less than" object_id__lte: required: false - type: array + type: integer description: "Object_id less than or equal to" object_id__n: required: false - type: array + type: integer description: "Object_id not equal to" object_type: required: false @@ -199,41 +199,93 @@ parameters: * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive" + priority__empty: + required: false + type: boolean + description: "Priority is empty/null (boolean)" + priority__ic: + required: false + type: string + description: "Priority contains (case-insensitive)" + priority__ie: + required: false + type: string + description: "Priority exact match (case-insensitive)" + priority__iew: + required: false + type: string + description: "Priority ends with (case-insensitive)" + priority__iregex: + required: false + type: string + description: "Priority" + priority__isw: + required: false + type: string + description: "Priority starts with (case-sensitive)" + priority__n: + required: false + type: string + description: "Priority not equal to" + priority__nic: + required: false + type: string + description: "Priority does not contain (case-insensitive)" + priority__nie: + required: false + type: string + description: "Priority inverse exact match (case-insensitive)" + priority__niew: + required: false + type: string + description: "Priority does not end with (case-insensitive)" + priority__nisw: + required: false + type: string + description: "Priority does not start with (case-sensitive)" + priority__regex: + required: false + type: string + description: "Priority" q: required: false type: string description: "Search" role: required: false - type: array + type: string description: "Contact role (slug)" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: integer description: "Contact role (ID)" role_id__n: required: false - type: array + type: integer description: "Role_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.tenancy.contact_groups.yaml b/actions/get.tenancy.contact_groups.yaml index cdf8cf3b..323921d8 100644 --- a/actions/get.tenancy.contact_groups.yaml +++ b/actions/get.tenancy.contact_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of contact group objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ancestor: required: false - type: array + type: string description: "Ancestor" ancestor__n: required: false - type: array + type: string description: "Ancestor not equal to" ancestor_id: required: false - type: array + type: string description: "Ancestor_id" ancestor_id__n: required: false - type: array + type: string description: "Ancestor_id not equal to" contact_id: required: false - type: array + type: integer description: "Contact (ID)" contact_id__n: required: false - type: array + type: integer description: "Contact_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,43 +86,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -130,51 +138,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -186,7 +194,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -194,40 +202,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -236,21 +252,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent contact group (slug)" parent__n: required: false - type: array + type: string description: "Parent not equal to" parent_id: required: false - type: array + type: integer description: "Parent contact group (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" q: required: false @@ -258,7 +306,7 @@ parameters: description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -266,55 +314,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.tenancy.contact_roles.yaml b/actions/get.tenancy.contact_roles.yaml index 894713be..87c69839 100644 --- a/actions/get.tenancy.contact_roles.yaml +++ b/actions/get.tenancy.contact_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of contact role objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,13 +228,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -226,55 +274,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.tenancy.contacts.yaml b/actions/get.tenancy.contacts.yaml index 620f57ac..867a11ad 100644 --- a/actions/get.tenancy.contacts.yaml +++ b/actions/get.tenancy.contacts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of contact objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. address: required: false - type: array + type: string description: "Address" address__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Address is empty/null (boolean)" address__ic: required: false - type: array + type: string description: "Address contains (case-insensitive)" address__ie: required: false - type: array + type: string description: "Address exact match (case-insensitive)" address__iew: required: false - type: array + type: string description: "Address ends with (case-insensitive)" + address__iregex: + required: false + type: string + description: "Address" address__isw: required: false - type: array + type: string description: "Address starts with (case-sensitive)" address__n: required: false - type: array + type: string description: "Address not equal to" address__nic: required: false - type: array + type: string description: "Address does not contain (case-insensitive)" address__nie: required: false - type: array + type: string description: "Address inverse exact match (case-insensitive)" address__niew: required: false - type: array + type: string description: "Address does not end with (case-insensitive)" address__nisw: required: false - type: array + type: string description: "Address does not start with (case-sensitive)" + address__regex: + required: false + type: string + description: "Address" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" email: required: false - type: array + type: string description: "Email" email__empty: required: false @@ -150,59 +166,67 @@ parameters: description: "Email is empty/null (boolean)" email__ic: required: false - type: array + type: string description: "Email contains (case-insensitive)" email__ie: required: false - type: array + type: string description: "Email exact match (case-insensitive)" email__iew: required: false - type: array + type: string description: "Email ends with (case-insensitive)" + email__iregex: + required: false + type: string + description: "Email" email__isw: required: false - type: array + type: string description: "Email starts with (case-sensitive)" email__n: required: false - type: array + type: string description: "Email not equal to" email__nic: required: false - type: array + type: string description: "Email does not contain (case-insensitive)" email__nie: required: false - type: array + type: string description: "Email inverse exact match (case-insensitive)" email__niew: required: false - type: array + type: string description: "Email does not end with (case-insensitive)" email__nisw: required: false - type: array + type: string description: "Email does not start with (case-sensitive)" + email__regex: + required: false + type: string + description: "Email" group: required: false - type: array + type: string description: "Group" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: string description: "Group_id" group_id__n: required: false - type: array + type: string description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -210,51 +234,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -262,7 +286,7 @@ parameters: description: "Number of results to return per page." link: required: false - type: array + type: string description: "Link" link__empty: required: false @@ -270,47 +294,55 @@ parameters: description: "Link is empty/null (boolean)" link__ic: required: false - type: array + type: string description: "Link contains (case-insensitive)" link__ie: required: false - type: array + type: string description: "Link exact match (case-insensitive)" link__iew: required: false - type: array + type: string description: "Link ends with (case-insensitive)" + link__iregex: + required: false + type: string + description: "Link" link__isw: required: false - type: array + type: string description: "Link starts with (case-sensitive)" link__n: required: false - type: array + type: string description: "Link not equal to" link__nic: required: false - type: array + type: string description: "Link does not contain (case-insensitive)" link__nie: required: false - type: array + type: string description: "Link inverse exact match (case-insensitive)" link__niew: required: false - type: array + type: string description: "Link does not end with (case-insensitive)" link__nisw: required: false - type: array + type: string description: "Link does not start with (case-sensitive)" + link__regex: + required: false + type: string + description: "Link" modified_by_request: required: false type: string description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -318,40 +350,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -360,9 +400,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" phone: required: false - type: array + type: string description: "Phone" phone__empty: required: false @@ -370,63 +442,75 @@ parameters: description: "Phone is empty/null (boolean)" phone__ic: required: false - type: array + type: string description: "Phone contains (case-insensitive)" phone__ie: required: false - type: array + type: string description: "Phone exact match (case-insensitive)" phone__iew: required: false - type: array + type: string description: "Phone ends with (case-insensitive)" + phone__iregex: + required: false + type: string + description: "Phone" phone__isw: required: false - type: array + type: string description: "Phone starts with (case-sensitive)" phone__n: required: false - type: array + type: string description: "Phone not equal to" phone__nic: required: false - type: array + type: string description: "Phone does not contain (case-insensitive)" phone__nie: required: false - type: array + type: string description: "Phone inverse exact match (case-insensitive)" phone__niew: required: false - type: array + type: string description: "Phone does not end with (case-insensitive)" phone__nisw: required: false - type: array + type: string description: "Phone does not start with (case-sensitive)" + phone__regex: + required: false + type: string + description: "Phone" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" title: required: false - type: array + type: string description: "Title" title__empty: required: false @@ -434,40 +518,48 @@ parameters: description: "Title is empty/null (boolean)" title__ic: required: false - type: array + type: string description: "Title contains (case-insensitive)" title__ie: required: false - type: array + type: string description: "Title exact match (case-insensitive)" title__iew: required: false - type: array + type: string description: "Title ends with (case-insensitive)" + title__iregex: + required: false + type: string + description: "Title" title__isw: required: false - type: array + type: string description: "Title starts with (case-sensitive)" title__n: required: false - type: array + type: string description: "Title not equal to" title__nic: required: false - type: array + type: string description: "Title does not contain (case-insensitive)" title__nie: required: false - type: array + type: string description: "Title inverse exact match (case-insensitive)" title__niew: required: false - type: array + type: string description: "Title does not end with (case-insensitive)" title__nisw: required: false - type: array + type: string description: "Title does not start with (case-sensitive)" + title__regex: + required: false + type: string + description: "Title" updated_by_request: required: false type: string diff --git a/actions/get.tenancy.tenant_groups.yaml b/actions/get.tenancy.tenant_groups.yaml index f960e85c..0c39ecf9 100644 --- a/actions/get.tenancy.tenant_groups.yaml +++ b/actions/get.tenancy.tenant_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of tenant group objects." enabled: true entry_point: run.py @@ -22,47 +22,47 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ancestor: required: false - type: array + type: string description: "Ancestor" ancestor__n: required: false - type: array + type: string description: "Ancestor not equal to" ancestor_id: required: false - type: array + type: string description: "Ancestor_id" ancestor_id__n: required: false - type: array + type: string description: "Ancestor_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -70,7 +70,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -78,43 +78,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -122,51 +130,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -178,7 +186,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -186,40 +194,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -228,21 +244,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent tenant group (slug)" parent__n: required: false - type: array + type: string description: "Parent not equal to" parent_id: required: false - type: array + type: integer description: "Parent tenant group (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" q: required: false @@ -250,7 +298,7 @@ parameters: description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -258,55 +306,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.tenancy.tenants.yaml b/actions/get.tenancy.tenants.yaml index a3ccf9c7..2e54e47a 100644 --- a/actions/get.tenancy.tenants.yaml +++ b/actions/get.tenancy.tenants.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of tenant objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,59 +86,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" group: required: false - type: array + type: string description: "Group" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: string description: "Group_id" group_id__n: required: false - type: array + type: string description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -146,51 +154,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -202,7 +210,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -210,40 +218,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -252,13 +268,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -266,55 +314,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.users.groups.yaml b/actions/get.users.groups.yaml index a06c8d81..d16c6ecc 100644 --- a/actions/get.users.groups.yaml +++ b/actions/get.users.groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of group objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -30,43 +30,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -74,23 +82,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" limit: required: false @@ -98,7 +106,7 @@ parameters: description: "Number of results to return per page." name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -106,47 +114,55 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" notification_group_id: required: false - type: array + type: integer description: "Notification group (ID)" notification_group_id__n: required: false - type: array + type: integer description: "Notification_group_id not equal to" offset: required: false @@ -156,25 +172,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" permission_id: required: false - type: array + type: integer description: "Permission (ID)" permission_id__n: required: false - type: array + type: integer description: "Permission_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." user_id: required: false - type: array + type: integer description: "User (ID)" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.users.owner_groups.yaml b/actions/get.users.owner_groups.yaml new file mode 100644 index 00000000..7eac37d1 --- /dev/null +++ b/actions/get.users.owner_groups.yaml @@ -0,0 +1,186 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Get a list of owner group objects." +enabled: true +entry_point: run.py +name: get.users.owner_groups +parameters: + endpoint_uri: + default: "/users/owner-groups/" + immutable: true + type: string + http_verb: + default: get + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + description: + required: false + type: string + description: "Description" + description__empty: + required: false + type: boolean + description: "Description is empty/null (boolean)" + description__ic: + required: false + type: string + description: "Description contains (case-insensitive)" + description__ie: + required: false + type: string + description: "Description exact match (case-insensitive)" + description__iew: + required: false + type: string + description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" + description__isw: + required: false + type: string + description: "Description starts with (case-sensitive)" + description__n: + required: false + type: string + description: "Description not equal to" + description__nic: + required: false + type: string + description: "Description does not contain (case-insensitive)" + description__nie: + required: false + type: string + description: "Description inverse exact match (case-insensitive)" + description__niew: + required: false + type: string + description: "Description does not end with (case-insensitive)" + description__nisw: + required: false + type: string + description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + id: + required: false + type: integer + description: "Id" + id__empty: + required: false + type: boolean + description: "Id is empty/null (boolean)" + id__gt: + required: false + type: integer + description: "Id greater than" + id__gte: + required: false + type: integer + description: "Id greater than or equal to" + id__lt: + required: false + type: integer + description: "Id less than" + id__lte: + required: false + type: integer + description: "Id less than or equal to" + id__n: + required: false + type: integer + description: "Id not equal to" + limit: + required: false + type: integer + description: "Number of results to return per page." + name: + required: false + type: string + description: "Name" + name__empty: + required: false + type: boolean + description: "Name is empty/null (boolean)" + name__ic: + required: false + type: string + description: "Name contains (case-insensitive)" + name__ie: + required: false + type: string + description: "Name exact match (case-insensitive)" + name__iew: + required: false + type: string + description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" + name__isw: + required: false + type: string + description: "Name starts with (case-sensitive)" + name__n: + required: false + type: string + description: "Name not equal to" + name__nic: + required: false + type: string + description: "Name does not contain (case-insensitive)" + name__nie: + required: false + type: string + description: "Name inverse exact match (case-insensitive)" + name__niew: + required: false + type: string + description: "Name does not end with (case-insensitive)" + name__nisw: + required: false + type: string + description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" + offset: + required: false + type: integer + description: "The initial index from which to return the results." + ordering: + required: false + type: string + description: "Which field to use when ordering the results." + q: + required: false + type: string + description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + save_in_key_store: + type: boolean + default: false + description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. + save_in_key_store_key_name: + type: string + description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. + save_in_key_store_ttl: + type: integer + default: 60 + description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. +runner_type: python-script diff --git a/actions/get.users.owners.yaml b/actions/get.users.owners.yaml new file mode 100644 index 00000000..e3a129cd --- /dev/null +++ b/actions/get.users.owners.yaml @@ -0,0 +1,234 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Get a list of owner objects." +enabled: true +entry_point: run.py +name: get.users.owners +parameters: + endpoint_uri: + default: "/users/owners/" + immutable: true + type: string + http_verb: + default: get + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + description: + required: false + type: string + description: "Description" + description__empty: + required: false + type: boolean + description: "Description is empty/null (boolean)" + description__ic: + required: false + type: string + description: "Description contains (case-insensitive)" + description__ie: + required: false + type: string + description: "Description exact match (case-insensitive)" + description__iew: + required: false + type: string + description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" + description__isw: + required: false + type: string + description: "Description starts with (case-sensitive)" + description__n: + required: false + type: string + description: "Description not equal to" + description__nic: + required: false + type: string + description: "Description does not contain (case-insensitive)" + description__nie: + required: false + type: string + description: "Description inverse exact match (case-insensitive)" + description__niew: + required: false + type: string + description: "Description does not end with (case-insensitive)" + description__nisw: + required: false + type: string + description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + group: + required: false + type: string + description: "Group (name)" + group__n: + required: false + type: string + description: "Group not equal to" + group_id: + required: false + type: integer + description: "Group (ID)" + group_id__n: + required: false + type: integer + description: "Group_id not equal to" + id: + required: false + type: integer + description: "Id" + id__empty: + required: false + type: boolean + description: "Id is empty/null (boolean)" + id__gt: + required: false + type: integer + description: "Id greater than" + id__gte: + required: false + type: integer + description: "Id greater than or equal to" + id__lt: + required: false + type: integer + description: "Id less than" + id__lte: + required: false + type: integer + description: "Id less than or equal to" + id__n: + required: false + type: integer + description: "Id not equal to" + limit: + required: false + type: integer + description: "Number of results to return per page." + name: + required: false + type: string + description: "Name" + name__empty: + required: false + type: boolean + description: "Name is empty/null (boolean)" + name__ic: + required: false + type: string + description: "Name contains (case-insensitive)" + name__ie: + required: false + type: string + description: "Name exact match (case-insensitive)" + name__iew: + required: false + type: string + description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" + name__isw: + required: false + type: string + description: "Name starts with (case-sensitive)" + name__n: + required: false + type: string + description: "Name not equal to" + name__nic: + required: false + type: string + description: "Name does not contain (case-insensitive)" + name__nie: + required: false + type: string + description: "Name inverse exact match (case-insensitive)" + name__niew: + required: false + type: string + description: "Name does not end with (case-insensitive)" + name__nisw: + required: false + type: string + description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" + offset: + required: false + type: integer + description: "The initial index from which to return the results." + ordering: + required: false + type: string + description: "Which field to use when ordering the results." + q: + required: false + type: string + description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + user: + required: false + type: string + description: "User (username)" + user__n: + required: false + type: string + description: "User not equal to" + user_group: + required: false + type: string + description: "User group (name)" + user_group__n: + required: false + type: string + description: "User_group not equal to" + user_group_id: + required: false + type: integer + description: "User group (ID)" + user_group_id__n: + required: false + type: integer + description: "User_group_id not equal to" + user_id: + required: false + type: integer + description: "User (ID)" + user_id__n: + required: false + type: integer + description: "User_id not equal to" + save_in_key_store: + type: boolean + default: false + description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. + save_in_key_store_key_name: + type: string + description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. + save_in_key_store_ttl: + type: integer + default: 60 + description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. +runner_type: python-script diff --git a/actions/get.users.permissions.yaml b/actions/get.users.permissions.yaml index 88231d48..c993a387 100644 --- a/actions/get.users.permissions.yaml +++ b/actions/get.users.permissions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of permission objects." enabled: true entry_point: run.py @@ -38,7 +38,7 @@ parameters: description: "Can_view" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -46,63 +46,71 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" enabled: required: false type: boolean description: "Enabled" group: required: false - type: array + type: string description: "Group (name)" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: integer description: "Group" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -110,23 +118,23 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" limit: required: false @@ -134,7 +142,7 @@ parameters: description: "Number of results to return per page." name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -142,40 +150,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" object_type: required: false type: string @@ -192,6 +208,10 @@ parameters: required: false type: string description: "Object_type ends with (case-insensitive)" + object_type__iregex: + required: false + type: string + description: "Object_type" object_type__isw: required: false type: string @@ -216,21 +236,25 @@ parameters: required: false type: string description: "Object_type does not start with (case-sensitive)" + object_type__regex: + required: false + type: string + description: "Object_type" object_type_id: required: false - type: array + type: integer description: "Object_type_id" object_type_id__n: required: false - type: array + type: integer description: "Object_type_id not equal to" object_types: required: false - type: array + type: integer description: "Object_types" object_types__n: required: false - type: array + type: integer description: "Object_types not equal to" offset: required: false @@ -244,21 +268,25 @@ parameters: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." user: required: false - type: array + type: string description: "User (name)" user__n: required: false - type: array + type: string description: "User not equal to" user_id: required: false - type: array + type: integer description: "User" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.users.tokens.yaml b/actions/get.users.tokens.yaml index 3ab4d39c..801fd7f3 100644 --- a/actions/get.users.tokens.yaml +++ b/actions/get.users.tokens.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of token objects." enabled: true entry_point: run.py @@ -34,7 +34,7 @@ parameters: description: "Created less than or equal to" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -42,40 +42,52 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + enabled: + required: false + type: boolean + description: "Enabled" expires: required: false type: string @@ -90,7 +102,7 @@ parameters: description: "Expires less than or equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -98,27 +110,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" key: required: false - type: array + type: string description: "Key" key__empty: required: false @@ -126,68 +138,60 @@ parameters: description: "Key is empty/null (boolean)" key__ic: required: false - type: array + type: string description: "Key contains (case-insensitive)" key__ie: required: false - type: array + type: string description: "Key exact match (case-insensitive)" key__iew: required: false - type: array + type: string description: "Key ends with (case-insensitive)" + key__iregex: + required: false + type: string + description: "Key" key__isw: required: false - type: array + type: string description: "Key starts with (case-sensitive)" key__n: required: false - type: array + type: string description: "Key not equal to" key__nic: required: false - type: array + type: string description: "Key does not contain (case-insensitive)" key__nie: required: false - type: array + type: string description: "Key inverse exact match (case-insensitive)" key__niew: required: false - type: array + type: string description: "Key does not end with (case-insensitive)" key__nisw: required: false - type: array + type: string description: "Key does not start with (case-sensitive)" + key__regex: + required: false + type: string + description: "Key" last_used: required: false - type: array + type: string description: "Last_used" - last_used__empty: - required: false - type: boolean - description: "Last_used is empty/null (boolean)" - last_used__gt: - required: false - type: array - description: "Last_used greater than" last_used__gte: required: false - type: array + type: string description: "Last_used greater than or equal to" - last_used__lt: - required: false - type: array - description: "Last_used less than" last_used__lte: required: false - type: array + type: string description: "Last_used less than or equal to" - last_used__n: - required: false - type: array - description: "Last_used not equal to" limit: required: false type: integer @@ -200,26 +204,107 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + pepper_id: + required: false + type: integer + description: "Pepper_id" + pepper_id__empty: + required: false + type: boolean + description: "Pepper_id is empty/null (boolean)" + pepper_id__gt: + required: false + type: integer + description: "Pepper_id greater than" + pepper_id__gte: + required: false + type: integer + description: "Pepper_id greater than or equal to" + pepper_id__lt: + required: false + type: integer + description: "Pepper_id less than" + pepper_id__lte: + required: false + type: integer + description: "Pepper_id less than or equal to" + pepper_id__n: + required: false + type: integer + description: "Pepper_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." user: required: false - type: array + type: string description: "User (name)" user__n: required: false - type: array + type: string description: "User not equal to" user_id: required: false - type: array + type: integer description: "User" user_id__n: required: false - type: array + type: integer description: "User_id not equal to" + version: + required: false + type: integer + description: "* `1` - v1 +* `2` - v2" + version__ic: + required: false + type: integer + description: "Version contains (case-insensitive)" + version__ie: + required: false + type: integer + description: "Version exact match (case-insensitive)" + version__iew: + required: false + type: integer + description: "Version ends with (case-insensitive)" + version__iregex: + required: false + type: integer + description: "Version" + version__isw: + required: false + type: integer + description: "Version starts with (case-sensitive)" + version__n: + required: false + type: integer + description: "Version not equal to" + version__nic: + required: false + type: integer + description: "Version does not contain (case-insensitive)" + version__nie: + required: false + type: integer + description: "Version inverse exact match (case-insensitive)" + version__niew: + required: false + type: integer + description: "Version does not end with (case-insensitive)" + version__nisw: + required: false + type: integer + description: "Version does not start with (case-sensitive)" + version__regex: + required: false + type: integer + description: "Version" write_enabled: required: false type: boolean diff --git a/actions/get.users.users.yaml b/actions/get.users.users.yaml index 9e6c3f2f..fd04a8be 100644 --- a/actions/get.users.users.yaml +++ b/actions/get.users.users.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of user objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. date_joined: required: false - type: array + type: string description: "Date_joined" date_joined__empty: required: false @@ -30,27 +30,27 @@ parameters: description: "Date_joined is empty/null (boolean)" date_joined__gt: required: false - type: array + type: string description: "Date_joined greater than" date_joined__gte: required: false - type: array + type: string description: "Date_joined greater than or equal to" date_joined__lt: required: false - type: array + type: string description: "Date_joined less than" date_joined__lte: required: false - type: array + type: string description: "Date_joined less than or equal to" date_joined__n: required: false - type: array + type: string description: "Date_joined not equal to" email: required: false - type: array + type: string description: "Email" email__empty: required: false @@ -58,43 +58,51 @@ parameters: description: "Email is empty/null (boolean)" email__ic: required: false - type: array + type: string description: "Email contains (case-insensitive)" email__ie: required: false - type: array + type: string description: "Email exact match (case-insensitive)" email__iew: required: false - type: array + type: string description: "Email ends with (case-insensitive)" + email__iregex: + required: false + type: string + description: "Email" email__isw: required: false - type: array + type: string description: "Email starts with (case-sensitive)" email__n: required: false - type: array + type: string description: "Email not equal to" email__nic: required: false - type: array + type: string description: "Email does not contain (case-insensitive)" email__nie: required: false - type: array + type: string description: "Email inverse exact match (case-insensitive)" email__niew: required: false - type: array + type: string description: "Email does not end with (case-insensitive)" email__nisw: required: false - type: array + type: string description: "Email does not start with (case-sensitive)" + email__regex: + required: false + type: string + description: "Email" first_name: required: false - type: array + type: string description: "First_name" first_name__empty: required: false @@ -102,59 +110,67 @@ parameters: description: "First_name is empty/null (boolean)" first_name__ic: required: false - type: array + type: string description: "First_name contains (case-insensitive)" first_name__ie: required: false - type: array + type: string description: "First_name exact match (case-insensitive)" first_name__iew: required: false - type: array + type: string description: "First_name ends with (case-insensitive)" + first_name__iregex: + required: false + type: string + description: "First_name" first_name__isw: required: false - type: array + type: string description: "First_name starts with (case-sensitive)" first_name__n: required: false - type: array + type: string description: "First_name not equal to" first_name__nic: required: false - type: array + type: string description: "First_name does not contain (case-insensitive)" first_name__nie: required: false - type: array + type: string description: "First_name inverse exact match (case-insensitive)" first_name__niew: required: false - type: array + type: string description: "First_name does not end with (case-insensitive)" first_name__nisw: required: false - type: array + type: string description: "First_name does not start with (case-sensitive)" + first_name__regex: + required: false + type: string + description: "First_name" group: required: false - type: array + type: string description: "Group (name)" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: integer description: "Group" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -162,39 +178,35 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" is_active: required: false type: boolean description: "Is_active" - is_staff: - required: false - type: boolean - description: "Is_staff" is_superuser: required: false type: boolean description: "Is_superuser" last_login: required: false - type: array + type: string description: "Last_login" last_login__empty: required: false @@ -202,27 +214,27 @@ parameters: description: "Last_login is empty/null (boolean)" last_login__gt: required: false - type: array + type: string description: "Last_login greater than" last_login__gte: required: false - type: array + type: string description: "Last_login greater than or equal to" last_login__lt: required: false - type: array + type: string description: "Last_login less than" last_login__lte: required: false - type: array + type: string description: "Last_login less than or equal to" last_login__n: required: false - type: array + type: string description: "Last_login not equal to" last_name: required: false - type: array + type: string description: "Last_name" last_name__empty: required: false @@ -230,51 +242,59 @@ parameters: description: "Last_name is empty/null (boolean)" last_name__ic: required: false - type: array + type: string description: "Last_name contains (case-insensitive)" last_name__ie: required: false - type: array + type: string description: "Last_name exact match (case-insensitive)" last_name__iew: required: false - type: array + type: string description: "Last_name ends with (case-insensitive)" + last_name__iregex: + required: false + type: string + description: "Last_name" last_name__isw: required: false - type: array + type: string description: "Last_name starts with (case-sensitive)" last_name__n: required: false - type: array + type: string description: "Last_name not equal to" last_name__nic: required: false - type: array + type: string description: "Last_name does not contain (case-insensitive)" last_name__nie: required: false - type: array + type: string description: "Last_name inverse exact match (case-insensitive)" last_name__niew: required: false - type: array + type: string description: "Last_name does not end with (case-insensitive)" last_name__nisw: required: false - type: array + type: string description: "Last_name does not start with (case-sensitive)" + last_name__regex: + required: false + type: string + description: "Last_name" limit: required: false type: integer description: "Number of results to return per page." notification_group_id: required: false - type: array + type: integer description: "Notification group (ID)" notification_group_id__n: required: false - type: array + type: integer description: "Notification_group_id not equal to" offset: required: false @@ -284,21 +304,41 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" permission_id: required: false - type: array + type: integer description: "Permission (ID)" permission_id__n: required: false - type: array + type: integer description: "Permission_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." username: required: false - type: array + type: string description: "Username" username__empty: required: false @@ -306,40 +346,48 @@ parameters: description: "Username is empty/null (boolean)" username__ic: required: false - type: array + type: string description: "Username contains (case-insensitive)" username__ie: required: false - type: array + type: string description: "Username exact match (case-insensitive)" username__iew: required: false - type: array + type: string description: "Username ends with (case-insensitive)" + username__iregex: + required: false + type: string + description: "Username" username__isw: required: false - type: array + type: string description: "Username starts with (case-sensitive)" username__n: required: false - type: array + type: string description: "Username not equal to" username__nic: required: false - type: array + type: string description: "Username does not contain (case-insensitive)" username__nie: required: false - type: array + type: string description: "Username inverse exact match (case-insensitive)" username__niew: required: false - type: array + type: string description: "Username does not end with (case-insensitive)" username__nisw: required: false - type: array + type: string description: "Username does not start with (case-sensitive)" + username__regex: + required: false + type: string + description: "Username" save_in_key_store: type: boolean default: false diff --git a/actions/get.virtualization.cluster_groups.yaml b/actions/get.virtualization.cluster_groups.yaml index fb5873de..dc4a78d2 100644 --- a/actions/get.virtualization.cluster_groups.yaml +++ b/actions/get.virtualization.cluster_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of cluster group objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,43 +86,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -130,51 +138,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -186,7 +194,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -194,40 +202,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -236,13 +252,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -250,55 +298,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.virtualization.cluster_types.yaml b/actions/get.virtualization.cluster_types.yaml index 0840d7d5..a1eb7727 100644 --- a/actions/get.virtualization.cluster_types.yaml +++ b/actions/get.virtualization.cluster_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of cluster type objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,13 +228,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -226,55 +274,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.virtualization.clusters.yaml b/actions/get.virtualization.clusters.yaml index 110ac72f..420827e7 100644 --- a/actions/get.virtualization.clusters.yaml +++ b/actions/get.virtualization.clusters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of cluster objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,59 +86,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" group: required: false - type: array + type: string description: "Parent group (slug)" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: integer description: "Parent group (ID)" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -146,51 +154,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -198,19 +206,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" modified_by_request: required: false @@ -218,7 +226,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -226,40 +234,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -268,29 +284,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" scope_id: required: false - type: array + type: integer description: "Scope_id" scope_id__empty: required: false @@ -298,23 +346,23 @@ parameters: description: "Scope_id is empty/null (boolean)" scope_id__gt: required: false - type: array + type: integer description: "Scope_id greater than" scope_id__gte: required: false - type: array + type: integer description: "Scope_id greater than or equal to" scope_id__lt: required: false - type: array + type: integer description: "Scope_id less than" scope_id__lte: required: false - type: array + type: integer description: "Scope_id less than or equal to" scope_id__n: required: false - type: array + type: integer description: "Scope_id not equal to" scope_type: required: false @@ -326,39 +374,43 @@ parameters: description: "Scope_type not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -366,103 +418,111 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Cluster type (slug)" type__n: required: false - type: array + type: string description: "Type not equal to" type_id: required: false - type: array + type: integer description: "Cluster type (ID)" type_id__n: required: false - type: array + type: integer description: "Type_id not equal to" updated_by_request: required: false diff --git a/actions/get.virtualization.interfaces.yaml b/actions/get.virtualization.interfaces.yaml index f1bc05bf..f52c1ea4 100644 --- a/actions/get.virtualization.interfaces.yaml +++ b/actions/get.virtualization.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of interface objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. bridge_id: required: false - type: array + type: integer description: "Bridged interface (ID)" bridge_id__n: required: false - type: array + type: integer description: "Bridge_id not equal to" cluster: required: false - type: array + type: string description: "Cluster" cluster__n: required: false - type: array + type: string description: "Cluster not equal to" cluster_id: required: false - type: array + type: integer description: "Cluster (ID)" cluster_id__n: required: false - type: array + type: integer description: "Cluster_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,47 +86,55 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" enabled: required: false type: boolean description: "Enabled" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -134,67 +142,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" l2vpn: required: false - type: array + type: integer description: "L2VPN" l2vpn__n: required: false - type: array + type: integer description: "L2vpn not equal to" l2vpn_id: required: false - type: array + type: integer description: "L2VPN (ID)" l2vpn_id__n: required: false - type: array + type: integer description: "L2vpn_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -202,47 +210,55 @@ parameters: description: "Number of results to return per page." mac_address: required: false - type: array + type: string description: "Mac_address" mac_address__ic: required: false - type: array + type: string description: "Mac_address contains (case-insensitive)" mac_address__ie: required: false - type: array + type: string description: "Mac_address exact match (case-insensitive)" mac_address__iew: required: false - type: array + type: string description: "Mac_address ends with (case-insensitive)" + mac_address__iregex: + required: false + type: string + description: "Mac_address" mac_address__isw: required: false - type: array + type: string description: "Mac_address starts with (case-sensitive)" mac_address__n: required: false - type: array + type: string description: "Mac_address not equal to" mac_address__nic: required: false - type: array + type: string description: "Mac_address does not contain (case-insensitive)" mac_address__nie: required: false - type: array + type: string description: "Mac_address inverse exact match (case-insensitive)" mac_address__niew: required: false - type: array + type: string description: "Mac_address does not end with (case-insensitive)" mac_address__nisw: required: false - type: array + type: string description: "Mac_address does not start with (case-sensitive)" + mac_address__regex: + required: false + type: string + description: "Mac_address" mode: required: false - type: array + type: string description: "802.1Q Mode" mode__empty: required: false @@ -250,47 +266,55 @@ parameters: description: "Mode is empty/null (boolean)" mode__ic: required: false - type: array + type: string description: "Mode contains (case-insensitive)" mode__ie: required: false - type: array + type: string description: "Mode exact match (case-insensitive)" mode__iew: required: false - type: array + type: string description: "Mode ends with (case-insensitive)" + mode__iregex: + required: false + type: string + description: "802.1Q Mode" mode__isw: required: false - type: array + type: string description: "Mode starts with (case-sensitive)" mode__n: required: false - type: array + type: string description: "Mode not equal to" mode__nic: required: false - type: array + type: string description: "Mode does not contain (case-insensitive)" mode__nie: required: false - type: array + type: string description: "Mode inverse exact match (case-insensitive)" mode__niew: required: false - type: array + type: string description: "Mode does not end with (case-insensitive)" mode__nisw: required: false - type: array + type: string description: "Mode does not start with (case-sensitive)" + mode__regex: + required: false + type: string + description: "802.1Q Mode" modified_by_request: required: false type: string description: "Modified_by_request" mtu: required: false - type: array + type: integer description: "Mtu" mtu__empty: required: false @@ -298,27 +322,27 @@ parameters: description: "Mtu is empty/null (boolean)" mtu__gt: required: false - type: array + type: integer description: "Mtu greater than" mtu__gte: required: false - type: array + type: integer description: "Mtu greater than or equal to" mtu__lt: required: false - type: array + type: integer description: "Mtu less than" mtu__lte: required: false - type: array + type: integer description: "Mtu less than or equal to" mtu__n: required: false - type: array + type: integer description: "Mtu not equal to" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -326,40 +350,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -368,49 +400,85 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent_id: required: false - type: array + type: integer description: "Parent interface (ID)" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" primary_mac_address: required: false - type: array + type: string description: "Primary MAC address" primary_mac_address__n: required: false - type: array + type: string description: "Primary_mac_address not equal to" primary_mac_address_id: required: false - type: array + type: integer description: "Primary MAC address (ID)" primary_mac_address_id__n: required: false - type: array + type: integer description: "Primary_mac_address_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -418,19 +486,19 @@ parameters: description: "Updated_by_request" virtual_machine: required: false - type: array + type: string description: "Virtual machine" virtual_machine__n: required: false - type: array + type: string description: "Virtual_machine not equal to" virtual_machine_id: required: false - type: array + type: integer description: "Virtual machine (ID)" virtual_machine_id__n: required: false - type: array + type: integer description: "Virtual_machine_id not equal to" vlan: required: false @@ -442,35 +510,35 @@ parameters: description: "Assigned VLAN" vlan_translation_policy: required: false - type: array + type: string description: "VLAN Translation Policy" vlan_translation_policy__n: required: false - type: array + type: string description: "Vlan_translation_policy not equal to" vlan_translation_policy_id: required: false - type: array + type: integer description: "VLAN Translation Policy (ID)" vlan_translation_policy_id__n: required: false - type: array + type: integer description: "Vlan_translation_policy_id not equal to" vrf: required: false - type: array + type: string description: "VRF (RD)" vrf__n: required: false - type: array + type: string description: "Vrf not equal to" vrf_id: required: false - type: array + type: integer description: "VRF" vrf_id__n: required: false - type: array + type: integer description: "Vrf_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.virtualization.virtual_disks.yaml b/actions/get.virtualization.virtual_disks.yaml index 9253945d..174edf71 100644 --- a/actions/get.virtualization.virtual_disks.yaml +++ b/actions/get.virtualization.virtual_disks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of virtual disk objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,51 +114,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -162,7 +170,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -170,40 +178,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -212,13 +228,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" size: required: false - type: array + type: integer description: "Size" size__empty: required: false @@ -226,39 +274,43 @@ parameters: description: "Size is empty/null (boolean)" size__gt: required: false - type: array + type: integer description: "Size greater than" size__gte: required: false - type: array + type: integer description: "Size greater than or equal to" size__lt: required: false - type: array + type: integer description: "Size less than" size__lte: required: false - type: array + type: integer description: "Size less than or equal to" size__n: required: false - type: array + type: integer description: "Size not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -266,19 +318,19 @@ parameters: description: "Updated_by_request" virtual_machine: required: false - type: array + type: string description: "Virtual machine" virtual_machine__n: required: false - type: array + type: string description: "Virtual_machine not equal to" virtual_machine_id: required: false - type: array + type: integer description: "Virtual machine (ID)" virtual_machine_id__n: required: false - type: array + type: integer description: "Virtual_machine_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.virtualization.virtual_machine_types.yaml b/actions/get.virtualization.virtual_machine_types.yaml new file mode 100644 index 00000000..156239e3 --- /dev/null +++ b/actions/get.virtualization.virtual_machine_types.yaml @@ -0,0 +1,454 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Get a list of virtual machine type objects." +enabled: true +entry_point: run.py +name: get.virtualization.virtual_machine_types +parameters: + endpoint_uri: + default: "/virtualization/virtual-machine-types/" + immutable: true + type: string + http_verb: + default: get + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + created: + required: false + type: string + description: "Created" + created__empty: + required: false + type: string + description: "Created is empty/null (boolean)" + created__gt: + required: false + type: string + description: "Created greater than" + created__gte: + required: false + type: string + description: "Created greater than or equal to" + created__lt: + required: false + type: string + description: "Created less than" + created__lte: + required: false + type: string + description: "Created less than or equal to" + created__n: + required: false + type: string + description: "Created not equal to" + created_by_request: + required: false + type: string + description: "Created_by_request" + default_memory: + required: false + type: integer + description: "Default_memory" + default_memory__empty: + required: false + type: boolean + description: "Default_memory is empty/null (boolean)" + default_memory__gt: + required: false + type: integer + description: "Default_memory greater than" + default_memory__gte: + required: false + type: integer + description: "Default_memory greater than or equal to" + default_memory__lt: + required: false + type: integer + description: "Default_memory less than" + default_memory__lte: + required: false + type: integer + description: "Default_memory less than or equal to" + default_memory__n: + required: false + type: integer + description: "Default_memory not equal to" + default_platform: + required: false + type: string + description: "Default_platform" + default_platform__n: + required: false + type: string + description: "Default_platform not equal to" + default_platform_id: + required: false + type: string + description: "Default_platform_id" + default_platform_id__n: + required: false + type: string + description: "Default_platform_id not equal to" + default_vcpus: + required: false + type: integer + description: "Default_vcpus" + default_vcpus__empty: + required: false + type: boolean + description: "Default_vcpus is empty/null (boolean)" + default_vcpus__gt: + required: false + type: integer + description: "Default_vcpus greater than" + default_vcpus__gte: + required: false + type: integer + description: "Default_vcpus greater than or equal to" + default_vcpus__lt: + required: false + type: integer + description: "Default_vcpus less than" + default_vcpus__lte: + required: false + type: integer + description: "Default_vcpus less than or equal to" + default_vcpus__n: + required: false + type: integer + description: "Default_vcpus not equal to" + description: + required: false + type: string + description: "Description" + description__empty: + required: false + type: boolean + description: "Description is empty/null (boolean)" + description__ic: + required: false + type: string + description: "Description contains (case-insensitive)" + description__ie: + required: false + type: string + description: "Description exact match (case-insensitive)" + description__iew: + required: false + type: string + description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" + description__isw: + required: false + type: string + description: "Description starts with (case-sensitive)" + description__n: + required: false + type: string + description: "Description not equal to" + description__nic: + required: false + type: string + description: "Description does not contain (case-insensitive)" + description__nie: + required: false + type: string + description: "Description inverse exact match (case-insensitive)" + description__niew: + required: false + type: string + description: "Description does not end with (case-insensitive)" + description__nisw: + required: false + type: string + description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" + id: + required: false + type: integer + description: "Id" + id__empty: + required: false + type: boolean + description: "Id is empty/null (boolean)" + id__gt: + required: false + type: integer + description: "Id greater than" + id__gte: + required: false + type: integer + description: "Id greater than or equal to" + id__lt: + required: false + type: integer + description: "Id less than" + id__lte: + required: false + type: integer + description: "Id less than or equal to" + id__n: + required: false + type: integer + description: "Id not equal to" + last_updated: + required: false + type: string + description: "Last_updated" + last_updated__empty: + required: false + type: string + description: "Last_updated is empty/null (boolean)" + last_updated__gt: + required: false + type: string + description: "Last_updated greater than" + last_updated__gte: + required: false + type: string + description: "Last_updated greater than or equal to" + last_updated__lt: + required: false + type: string + description: "Last_updated less than" + last_updated__lte: + required: false + type: string + description: "Last_updated less than or equal to" + last_updated__n: + required: false + type: string + description: "Last_updated not equal to" + limit: + required: false + type: integer + description: "Number of results to return per page." + modified_by_request: + required: false + type: string + description: "Modified_by_request" + name: + required: false + type: string + description: "Name" + name__empty: + required: false + type: boolean + description: "Name is empty/null (boolean)" + name__ic: + required: false + type: string + description: "Name contains (case-insensitive)" + name__ie: + required: false + type: string + description: "Name exact match (case-insensitive)" + name__iew: + required: false + type: string + description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" + name__isw: + required: false + type: string + description: "Name starts with (case-sensitive)" + name__n: + required: false + type: string + description: "Name not equal to" + name__nic: + required: false + type: string + description: "Name does not contain (case-insensitive)" + name__nie: + required: false + type: string + description: "Name inverse exact match (case-insensitive)" + name__niew: + required: false + type: string + description: "Name does not end with (case-insensitive)" + name__nisw: + required: false + type: string + description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" + offset: + required: false + type: integer + description: "The initial index from which to return the results." + ordering: + required: false + type: string + description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" + q: + required: false + type: string + description: "Search" + slug: + required: false + type: string + description: "Slug" + slug__empty: + required: false + type: boolean + description: "Slug is empty/null (boolean)" + slug__ic: + required: false + type: string + description: "Slug contains (case-insensitive)" + slug__ie: + required: false + type: string + description: "Slug exact match (case-insensitive)" + slug__iew: + required: false + type: string + description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" + slug__isw: + required: false + type: string + description: "Slug starts with (case-sensitive)" + slug__n: + required: false + type: string + description: "Slug not equal to" + slug__nic: + required: false + type: string + description: "Slug does not contain (case-insensitive)" + slug__nie: + required: false + type: string + description: "Slug inverse exact match (case-insensitive)" + slug__niew: + required: false + type: string + description: "Slug does not end with (case-insensitive)" + slug__nisw: + required: false + type: string + description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + tag: + required: false + type: string + description: "Tag" + tag__n: + required: false + type: string + description: "Tag not equal to" + tag_id: + required: false + type: integer + description: "Tag_id" + tag_id__n: + required: false + type: integer + description: "Tag_id not equal to" + updated_by_request: + required: false + type: string + description: "Updated_by_request" + virtual_machine_count: + required: false + type: integer + description: "Virtual_machine_count" + virtual_machine_count__empty: + required: false + type: boolean + description: "Virtual_machine_count is empty/null (boolean)" + virtual_machine_count__gt: + required: false + type: integer + description: "Virtual_machine_count greater than" + virtual_machine_count__gte: + required: false + type: integer + description: "Virtual_machine_count greater than or equal to" + virtual_machine_count__lt: + required: false + type: integer + description: "Virtual_machine_count less than" + virtual_machine_count__lte: + required: false + type: integer + description: "Virtual_machine_count less than or equal to" + virtual_machine_count__n: + required: false + type: integer + description: "Virtual_machine_count not equal to" + save_in_key_store: + type: boolean + default: false + description: Save the result of the action as a json object in the st2 key store. Used when the expected result from Netbox is very large and the result will be piped to another action. You must also specify a save_in_key_store_keyname and an optional save_in_key_store_ttl. + save_in_key_store_key_name: + type: string + description: Name of the key to store the json result value in the st2 key store. Must be used with save_in_key_store and optionally save_in_key_store_ttl. + save_in_key_store_ttl: + type: integer + default: 60 + description: TTL (seconds) of the saved json result in the st2 key store. Defaults to 60 seconds. Must be used with save_in_key_store and save_in_key_store_key_name. +runner_type: python-script diff --git a/actions/get.virtualization.virtual_machines.yaml b/actions/get.virtualization.virtual_machines.yaml index 778be18e..ed63c350 100644 --- a/actions/get.virtualization.virtual_machines.yaml +++ b/actions/get.virtualization.virtual_machines.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of virtual machine objects." enabled: true entry_point: run.py @@ -22,111 +22,111 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. cluster: required: false - type: array + type: string description: "Cluster" cluster__n: required: false - type: array + type: string description: "Cluster not equal to" cluster_group: required: false - type: array + type: string description: "Cluster group (slug)" cluster_group__n: required: false - type: array + type: string description: "Cluster_group not equal to" cluster_group_id: required: false - type: array + type: integer description: "Cluster group (ID)" cluster_group_id__n: required: false - type: array + type: integer description: "Cluster_group_id not equal to" cluster_id: required: false - type: array + type: integer description: "Cluster (ID)" cluster_id__n: required: false - type: array + type: integer description: "Cluster_id not equal to" cluster_type: required: false - type: array + type: string description: "Cluster type (slug)" cluster_type__n: required: false - type: array + type: string description: "Cluster_type not equal to" cluster_type_id: required: false - type: array + type: integer description: "Cluster type (ID)" cluster_type_id__n: required: false - type: array + type: integer description: "Cluster_type_id not equal to" config_template_id: required: false - type: array + type: integer description: "Config template (ID)" config_template_id__n: required: false - type: array + type: integer description: "Config_template_id not equal to" contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -134,7 +134,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -142,59 +142,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" device: required: false - type: array + type: string description: "Device" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" disk: required: false - type: array + type: integer description: "Disk" disk__empty: required: false @@ -202,23 +210,23 @@ parameters: description: "Disk is empty/null (boolean)" disk__gt: required: false - type: array + type: integer description: "Disk greater than" disk__gte: required: false - type: array + type: integer description: "Disk greater than or equal to" disk__lt: required: false - type: array + type: integer description: "Disk less than" disk__lte: required: false - type: array + type: integer description: "Disk less than or equal to" disk__n: required: false - type: array + type: integer description: "Disk not equal to" has_primary_ip: required: false @@ -226,7 +234,7 @@ parameters: description: "Has a primary IP" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -234,27 +242,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_count: required: false - type: array + type: integer description: "Interface_count" interface_count__empty: required: false @@ -262,51 +270,51 @@ parameters: description: "Interface_count is empty/null (boolean)" interface_count__gt: required: false - type: array + type: integer description: "Interface_count greater than" interface_count__gte: required: false - type: array + type: integer description: "Interface_count greater than or equal to" interface_count__lt: required: false - type: array + type: integer description: "Interface_count less than" interface_count__lte: required: false - type: array + type: integer description: "Interface_count less than or equal to" interface_count__n: required: false - type: array + type: integer description: "Interface_count not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -318,47 +326,55 @@ parameters: description: "Has local config context data" mac_address: required: false - type: array + type: string description: "Mac_address" mac_address__ic: required: false - type: array + type: string description: "Mac_address contains (case-insensitive)" mac_address__ie: required: false - type: array + type: string description: "Mac_address exact match (case-insensitive)" mac_address__iew: required: false - type: array + type: string description: "Mac_address ends with (case-insensitive)" + mac_address__iregex: + required: false + type: string + description: "Mac_address" mac_address__isw: required: false - type: array + type: string description: "Mac_address starts with (case-sensitive)" mac_address__n: required: false - type: array + type: string description: "Mac_address not equal to" mac_address__nic: required: false - type: array + type: string description: "Mac_address does not contain (case-insensitive)" mac_address__nie: required: false - type: array + type: string description: "Mac_address inverse exact match (case-insensitive)" mac_address__niew: required: false - type: array + type: string description: "Mac_address does not end with (case-insensitive)" mac_address__nisw: required: false - type: array + type: string description: "Mac_address does not start with (case-sensitive)" + mac_address__regex: + required: false + type: string + description: "Mac_address" memory: required: false - type: array + type: integer description: "Memory" memory__empty: required: false @@ -366,23 +382,23 @@ parameters: description: "Memory is empty/null (boolean)" memory__gt: required: false - type: array + type: integer description: "Memory greater than" memory__gte: required: false - type: array + type: integer description: "Memory greater than or equal to" memory__lt: required: false - type: array + type: integer description: "Memory less than" memory__lte: required: false - type: array + type: integer description: "Memory less than or equal to" memory__n: required: false - type: array + type: integer description: "Memory not equal to" modified_by_request: required: false @@ -390,7 +406,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -398,40 +414,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -440,53 +464,85 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" platform: required: false - type: array - description: "Platform (slug)" + type: string + description: "Platform" platform__n: required: false - type: array + type: string description: "Platform not equal to" platform_id: required: false - type: array - description: "Platform (ID)" + type: string + description: "Platform_id" platform_id__n: required: false - type: array + type: string description: "Platform_id not equal to" primary_ip4: required: false - type: array + type: string description: "Primary IPv4 (address)" primary_ip4__n: required: false - type: array + type: string description: "Primary_ip4 not equal to" primary_ip4_id: required: false - type: array + type: integer description: "Primary IPv4 (ID)" primary_ip4_id__n: required: false - type: array + type: integer description: "Primary_ip4_id not equal to" primary_ip6: required: false - type: array + type: string description: "Primary IPv6 (address)" primary_ip6__n: required: false - type: array + type: string description: "Primary_ip6 not equal to" primary_ip6_id: required: false - type: array + type: integer description: "Primary IPv6 (ID)" primary_ip6_id__n: required: false - type: array + type: integer description: "Primary_ip6_id not equal to" q: required: false @@ -494,39 +550,39 @@ parameters: description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" role: required: false - type: array + type: string description: "Role" role__n: required: false - type: array + type: string description: "Role not equal to" role_id: required: false - type: array + type: string description: "Role_id" role_id__n: required: false - type: array + type: string description: "Role_id not equal to" serial: required: false - type: array + type: string description: "Serial" serial__empty: required: false @@ -534,75 +590,139 @@ parameters: description: "Serial is empty/null (boolean)" serial__ic: required: false - type: array + type: string description: "Serial contains (case-insensitive)" serial__ie: required: false - type: array + type: string description: "Serial exact match (case-insensitive)" serial__iew: required: false - type: array + type: string description: "Serial ends with (case-insensitive)" + serial__iregex: + required: false + type: string + description: "Serial" serial__isw: required: false - type: array + type: string description: "Serial starts with (case-sensitive)" serial__n: required: false - type: array + type: string description: "Serial not equal to" serial__nic: required: false - type: array + type: string description: "Serial does not contain (case-insensitive)" serial__nie: required: false - type: array + type: string description: "Serial inverse exact match (case-insensitive)" serial__niew: required: false - type: array + type: string description: "Serial does not end with (case-insensitive)" serial__nisw: required: false - type: array + type: string description: "Serial does not start with (case-sensitive)" + serial__regex: + required: false + type: string + description: "Serial" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." + start_on_boot: + required: false + type: string + description: "Start_on_boot" + start_on_boot__empty: + required: false + type: boolean + description: "Start_on_boot is empty/null (boolean)" + start_on_boot__ic: + required: false + type: string + description: "Start_on_boot contains (case-insensitive)" + start_on_boot__ie: + required: false + type: string + description: "Start_on_boot exact match (case-insensitive)" + start_on_boot__iew: + required: false + type: string + description: "Start_on_boot ends with (case-insensitive)" + start_on_boot__iregex: + required: false + type: string + description: "Start_on_boot" + start_on_boot__isw: + required: false + type: string + description: "Start_on_boot starts with (case-sensitive)" + start_on_boot__n: + required: false + type: string + description: "Start_on_boot not equal to" + start_on_boot__nic: + required: false + type: string + description: "Start_on_boot does not contain (case-insensitive)" + start_on_boot__nie: + required: false + type: string + description: "Start_on_boot inverse exact match (case-insensitive)" + start_on_boot__niew: + required: false + type: string + description: "Start_on_boot does not end with (case-insensitive)" + start_on_boot__nisw: + required: false + type: string + description: "Start_on_boot does not start with (case-sensitive)" + start_on_boot__regex: + required: false + type: string + description: "Start_on_boot" status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -610,87 +730,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -698,7 +826,7 @@ parameters: description: "Updated_by_request" vcpus: required: false - type: array + type: integer description: "Vcpus" vcpus__empty: required: false @@ -706,27 +834,27 @@ parameters: description: "Vcpus is empty/null (boolean)" vcpus__gt: required: false - type: array + type: integer description: "Vcpus greater than" vcpus__gte: required: false - type: array + type: integer description: "Vcpus greater than or equal to" vcpus__lt: required: false - type: array + type: integer description: "Vcpus less than" vcpus__lte: required: false - type: array + type: integer description: "Vcpus less than or equal to" vcpus__n: required: false - type: array + type: integer description: "Vcpus not equal to" virtual_disk_count: required: false - type: array + type: integer description: "Virtual_disk_count" virtual_disk_count__empty: required: false @@ -734,24 +862,40 @@ parameters: description: "Virtual_disk_count is empty/null (boolean)" virtual_disk_count__gt: required: false - type: array + type: integer description: "Virtual_disk_count greater than" virtual_disk_count__gte: required: false - type: array + type: integer description: "Virtual_disk_count greater than or equal to" virtual_disk_count__lt: required: false - type: array + type: integer description: "Virtual_disk_count less than" virtual_disk_count__lte: required: false - type: array + type: integer description: "Virtual_disk_count less than or equal to" virtual_disk_count__n: required: false - type: array + type: integer description: "Virtual_disk_count not equal to" + virtual_machine_type: + required: false + type: string + description: "Virtual machine type (slug)" + virtual_machine_type__n: + required: false + type: string + description: "Virtual_machine_type not equal to" + virtual_machine_type_id: + required: false + type: integer + description: "Virtual machine type (ID)" + virtual_machine_type_id__n: + required: false + type: integer + description: "Virtual_machine_type_id not equal to" save_in_key_store: type: boolean default: false diff --git a/actions/get.vpn.ike_policies.yaml b/actions/get.vpn.ike_policies.yaml index 256363b9..43259e51 100644 --- a/actions/get.vpn.ike_policies.yaml +++ b/actions/get.vpn.ike_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of IKE policy objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,67 +114,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" ike_proposal: required: false - type: array + type: string description: "Ike_proposal" ike_proposal__n: required: false - type: array + type: string description: "Ike_proposal not equal to" ike_proposal_id: required: false - type: array + type: integer description: "Ike_proposal_id" ike_proposal_id__n: required: false - type: array + type: integer description: "Ike_proposal_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -174,7 +182,7 @@ parameters: description: "Number of results to return per page." mode: required: false - type: array + type: string description: "Mode" mode__empty: required: false @@ -182,47 +190,55 @@ parameters: description: "Mode is empty/null (boolean)" mode__ic: required: false - type: array + type: string description: "Mode contains (case-insensitive)" mode__ie: required: false - type: array + type: string description: "Mode exact match (case-insensitive)" mode__iew: required: false - type: array + type: string description: "Mode ends with (case-insensitive)" + mode__iregex: + required: false + type: string + description: "Mode" mode__isw: required: false - type: array + type: string description: "Mode starts with (case-sensitive)" mode__n: required: false - type: array + type: string description: "Mode not equal to" mode__nic: required: false - type: array + type: string description: "Mode does not contain (case-insensitive)" mode__nie: required: false - type: array + type: string description: "Mode inverse exact match (case-insensitive)" mode__niew: required: false - type: array + type: string description: "Mode does not end with (case-insensitive)" mode__nisw: required: false - type: array + type: string description: "Mode does not start with (case-sensitive)" + mode__regex: + required: false + type: string + description: "Mode" modified_by_request: required: false type: string description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -230,40 +246,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -272,6 +296,38 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" preshared_key: required: false type: string @@ -288,6 +344,10 @@ parameters: required: false type: string description: "Preshared_key ends with (case-insensitive)" + preshared_key__iregex: + required: false + type: string + description: "Preshared_key" preshared_key__isw: required: false type: string @@ -312,25 +372,33 @@ parameters: required: false type: string description: "Preshared_key does not start with (case-sensitive)" + preshared_key__regex: + required: false + type: string + description: "Preshared_key" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -338,44 +406,52 @@ parameters: description: "Updated_by_request" version: required: false - type: array + type: integer description: "Version" version__ic: required: false - type: array + type: integer description: "Version contains (case-insensitive)" version__ie: required: false - type: array + type: integer description: "Version exact match (case-insensitive)" version__iew: required: false - type: array + type: integer description: "Version ends with (case-insensitive)" + version__iregex: + required: false + type: integer + description: "Version" version__isw: required: false - type: array + type: integer description: "Version starts with (case-sensitive)" version__n: required: false - type: array + type: integer description: "Version not equal to" version__nic: required: false - type: array + type: integer description: "Version does not contain (case-insensitive)" version__nie: required: false - type: array + type: integer description: "Version inverse exact match (case-insensitive)" version__niew: required: false - type: array + type: integer description: "Version does not end with (case-insensitive)" version__nisw: required: false - type: array + type: integer description: "Version does not start with (case-sensitive)" + version__regex: + required: false + type: integer + description: "Version" save_in_key_store: type: boolean default: false diff --git a/actions/get.vpn.ike_proposals.yaml b/actions/get.vpn.ike_proposals.yaml index 020983f2..003806e8 100644 --- a/actions/get.vpn.ike_proposals.yaml +++ b/actions/get.vpn.ike_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of IKE proposal objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. authentication_algorithm: required: false - type: array + type: string description: "Authentication_algorithm" authentication_algorithm__empty: required: false @@ -30,43 +30,51 @@ parameters: description: "Authentication_algorithm is empty/null (boolean)" authentication_algorithm__ic: required: false - type: array + type: string description: "Authentication_algorithm contains (case-insensitive)" authentication_algorithm__ie: required: false - type: array + type: string description: "Authentication_algorithm exact match (case-insensitive)" authentication_algorithm__iew: required: false - type: array + type: string description: "Authentication_algorithm ends with (case-insensitive)" + authentication_algorithm__iregex: + required: false + type: string + description: "Authentication_algorithm" authentication_algorithm__isw: required: false - type: array + type: string description: "Authentication_algorithm starts with (case-sensitive)" authentication_algorithm__n: required: false - type: array + type: string description: "Authentication_algorithm not equal to" authentication_algorithm__nic: required: false - type: array + type: string description: "Authentication_algorithm does not contain (case-insensitive)" authentication_algorithm__nie: required: false - type: array + type: string description: "Authentication_algorithm inverse exact match (case-insensitive)" authentication_algorithm__niew: required: false - type: array + type: string description: "Authentication_algorithm does not end with (case-insensitive)" authentication_algorithm__nisw: required: false - type: array + type: string description: "Authentication_algorithm does not start with (case-sensitive)" + authentication_algorithm__regex: + required: false + type: string + description: "Authentication_algorithm" authentication_method: required: false - type: array + type: string description: "Authentication_method" authentication_method__empty: required: false @@ -74,67 +82,75 @@ parameters: description: "Authentication_method is empty/null (boolean)" authentication_method__ic: required: false - type: array + type: string description: "Authentication_method contains (case-insensitive)" authentication_method__ie: required: false - type: array + type: string description: "Authentication_method exact match (case-insensitive)" authentication_method__iew: required: false - type: array + type: string description: "Authentication_method ends with (case-insensitive)" + authentication_method__iregex: + required: false + type: string + description: "Authentication_method" authentication_method__isw: required: false - type: array + type: string description: "Authentication_method starts with (case-sensitive)" authentication_method__n: required: false - type: array + type: string description: "Authentication_method not equal to" authentication_method__nic: required: false - type: array + type: string description: "Authentication_method does not contain (case-insensitive)" authentication_method__nie: required: false - type: array + type: string description: "Authentication_method inverse exact match (case-insensitive)" authentication_method__niew: required: false - type: array + type: string description: "Authentication_method does not end with (case-insensitive)" authentication_method__nisw: required: false - type: array + type: string description: "Authentication_method does not start with (case-sensitive)" + authentication_method__regex: + required: false + type: string + description: "Authentication_method" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -142,7 +158,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -150,43 +166,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" encryption_algorithm: required: false - type: array + type: string description: "Encryption_algorithm" encryption_algorithm__empty: required: false @@ -194,83 +218,99 @@ parameters: description: "Encryption_algorithm is empty/null (boolean)" encryption_algorithm__ic: required: false - type: array + type: string description: "Encryption_algorithm contains (case-insensitive)" encryption_algorithm__ie: required: false - type: array + type: string description: "Encryption_algorithm exact match (case-insensitive)" encryption_algorithm__iew: required: false - type: array + type: string description: "Encryption_algorithm ends with (case-insensitive)" + encryption_algorithm__iregex: + required: false + type: string + description: "Encryption_algorithm" encryption_algorithm__isw: required: false - type: array + type: string description: "Encryption_algorithm starts with (case-sensitive)" encryption_algorithm__n: required: false - type: array + type: string description: "Encryption_algorithm not equal to" encryption_algorithm__nic: required: false - type: array + type: string description: "Encryption_algorithm does not contain (case-insensitive)" encryption_algorithm__nie: required: false - type: array + type: string description: "Encryption_algorithm inverse exact match (case-insensitive)" encryption_algorithm__niew: required: false - type: array + type: string description: "Encryption_algorithm does not end with (case-insensitive)" encryption_algorithm__nisw: required: false - type: array + type: string description: "Encryption_algorithm does not start with (case-sensitive)" + encryption_algorithm__regex: + required: false + type: string + description: "Encryption_algorithm" group: required: false - type: array + type: integer description: "Diffie-Hellman group ID" group__ic: required: false - type: array + type: integer description: "Group contains (case-insensitive)" group__ie: required: false - type: array + type: integer description: "Group exact match (case-insensitive)" group__iew: required: false - type: array + type: integer description: "Group ends with (case-insensitive)" + group__iregex: + required: false + type: integer + description: "Diffie-Hellman group ID" group__isw: required: false - type: array + type: integer description: "Group starts with (case-sensitive)" group__n: required: false - type: array + type: integer description: "Group not equal to" group__nic: required: false - type: array + type: integer description: "Group does not contain (case-insensitive)" group__nie: required: false - type: array + type: integer description: "Group inverse exact match (case-insensitive)" group__niew: required: false - type: array + type: integer description: "Group does not end with (case-insensitive)" group__nisw: required: false - type: array + type: integer description: "Group does not start with (case-sensitive)" + group__regex: + required: false + type: integer + description: "Diffie-Hellman group ID" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -278,67 +318,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" ike_policy: required: false - type: array + type: string description: "IKE policy (name)" ike_policy__n: required: false - type: array + type: string description: "Ike_policy not equal to" ike_policy_id: required: false - type: array + type: integer description: "IKE policy (ID)" ike_policy_id__n: required: false - type: array + type: integer description: "Ike_policy_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -350,7 +390,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -358,40 +398,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -400,13 +448,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" sa_lifetime: required: false - type: array + type: integer description: "Sa_lifetime" sa_lifetime__empty: required: false @@ -414,39 +494,43 @@ parameters: description: "Sa_lifetime is empty/null (boolean)" sa_lifetime__gt: required: false - type: array + type: integer description: "Sa_lifetime greater than" sa_lifetime__gte: required: false - type: array + type: integer description: "Sa_lifetime greater than or equal to" sa_lifetime__lt: required: false - type: array + type: integer description: "Sa_lifetime less than" sa_lifetime__lte: required: false - type: array + type: integer description: "Sa_lifetime less than or equal to" sa_lifetime__n: required: false - type: array + type: integer description: "Sa_lifetime not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.vpn.ipsec_policies.yaml b/actions/get.vpn.ipsec_policies.yaml index f256553a..1387f5bc 100644 --- a/actions/get.vpn.ipsec_policies.yaml +++ b/actions/get.vpn.ipsec_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of IPSec policy objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,67 +114,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" ipsec_proposal: required: false - type: array + type: string description: "Ipsec_proposal" ipsec_proposal__n: required: false - type: array + type: string description: "Ipsec_proposal not equal to" ipsec_proposal_id: required: false - type: array + type: integer description: "Ipsec_proposal_id" ipsec_proposal_id__n: required: false - type: array + type: integer description: "Ipsec_proposal_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -178,7 +186,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -186,40 +194,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -228,65 +244,109 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" pfs_group: required: false - type: array + type: integer description: "Diffie-Hellman group for Perfect Forward Secrecy" pfs_group__ic: required: false - type: array + type: integer description: "Pfs_group contains (case-insensitive)" pfs_group__ie: required: false - type: array + type: integer description: "Pfs_group exact match (case-insensitive)" pfs_group__iew: required: false - type: array + type: integer description: "Pfs_group ends with (case-insensitive)" + pfs_group__iregex: + required: false + type: integer + description: "Diffie-Hellman group for Perfect Forward Secrecy" pfs_group__isw: required: false - type: array + type: integer description: "Pfs_group starts with (case-sensitive)" pfs_group__n: required: false - type: array + type: integer description: "Pfs_group not equal to" pfs_group__nic: required: false - type: array + type: integer description: "Pfs_group does not contain (case-insensitive)" pfs_group__nie: required: false - type: array + type: integer description: "Pfs_group inverse exact match (case-insensitive)" pfs_group__niew: required: false - type: array + type: integer description: "Pfs_group does not end with (case-insensitive)" pfs_group__nisw: required: false - type: array + type: integer description: "Pfs_group does not start with (case-sensitive)" + pfs_group__regex: + required: false + type: integer + description: "Diffie-Hellman group for Perfect Forward Secrecy" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.vpn.ipsec_profiles.yaml b/actions/get.vpn.ipsec_profiles.yaml index 6fdd03eb..6a7389c9 100644 --- a/actions/get.vpn.ipsec_profiles.yaml +++ b/actions/get.vpn.ipsec_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of IPSec profile objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -62,43 +62,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -106,83 +114,83 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" ike_policy: required: false - type: array + type: string description: "IKE policy (name)" ike_policy__n: required: false - type: array + type: string description: "Ike_policy not equal to" ike_policy_id: required: false - type: array + type: integer description: "IKE policy (ID)" ike_policy_id__n: required: false - type: array + type: integer description: "Ike_policy_id not equal to" ipsec_policy: required: false - type: array + type: string description: "IPSec policy (name)" ipsec_policy__n: required: false - type: array + type: string description: "Ipsec_policy not equal to" ipsec_policy_id: required: false - type: array + type: integer description: "IPSec policy (ID)" ipsec_policy_id__n: required: false - type: array + type: integer description: "Ipsec_policy_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -190,7 +198,7 @@ parameters: description: "Number of results to return per page." mode: required: false - type: array + type: string description: "Mode" mode__empty: required: false @@ -198,47 +206,55 @@ parameters: description: "Mode is empty/null (boolean)" mode__ic: required: false - type: array + type: string description: "Mode contains (case-insensitive)" mode__ie: required: false - type: array + type: string description: "Mode exact match (case-insensitive)" mode__iew: required: false - type: array + type: string description: "Mode ends with (case-insensitive)" + mode__iregex: + required: false + type: string + description: "Mode" mode__isw: required: false - type: array + type: string description: "Mode starts with (case-sensitive)" mode__n: required: false - type: array + type: string description: "Mode not equal to" mode__nic: required: false - type: array + type: string description: "Mode does not contain (case-insensitive)" mode__nie: required: false - type: array + type: string description: "Mode inverse exact match (case-insensitive)" mode__niew: required: false - type: array + type: string description: "Mode does not end with (case-insensitive)" mode__nisw: required: false - type: array + type: string description: "Mode does not start with (case-sensitive)" + mode__regex: + required: false + type: string + description: "Mode" modified_by_request: required: false type: string description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -246,40 +262,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -288,25 +312,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.vpn.ipsec_proposals.yaml b/actions/get.vpn.ipsec_proposals.yaml index aa746674..c049c6d5 100644 --- a/actions/get.vpn.ipsec_proposals.yaml +++ b/actions/get.vpn.ipsec_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of IPSec proposal objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. authentication_algorithm: required: false - type: array + type: string description: "Authentication_algorithm" authentication_algorithm__empty: required: false @@ -30,67 +30,75 @@ parameters: description: "Authentication_algorithm is empty/null (boolean)" authentication_algorithm__ic: required: false - type: array + type: string description: "Authentication_algorithm contains (case-insensitive)" authentication_algorithm__ie: required: false - type: array + type: string description: "Authentication_algorithm exact match (case-insensitive)" authentication_algorithm__iew: required: false - type: array + type: string description: "Authentication_algorithm ends with (case-insensitive)" + authentication_algorithm__iregex: + required: false + type: string + description: "Authentication_algorithm" authentication_algorithm__isw: required: false - type: array + type: string description: "Authentication_algorithm starts with (case-sensitive)" authentication_algorithm__n: required: false - type: array + type: string description: "Authentication_algorithm not equal to" authentication_algorithm__nic: required: false - type: array + type: string description: "Authentication_algorithm does not contain (case-insensitive)" authentication_algorithm__nie: required: false - type: array + type: string description: "Authentication_algorithm inverse exact match (case-insensitive)" authentication_algorithm__niew: required: false - type: array + type: string description: "Authentication_algorithm does not end with (case-insensitive)" authentication_algorithm__nisw: required: false - type: array + type: string description: "Authentication_algorithm does not start with (case-sensitive)" + authentication_algorithm__regex: + required: false + type: string + description: "Authentication_algorithm" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -98,7 +106,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -106,43 +114,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" encryption_algorithm: required: false - type: array + type: string description: "Encryption_algorithm" encryption_algorithm__empty: required: false @@ -150,43 +166,51 @@ parameters: description: "Encryption_algorithm is empty/null (boolean)" encryption_algorithm__ic: required: false - type: array + type: string description: "Encryption_algorithm contains (case-insensitive)" encryption_algorithm__ie: required: false - type: array + type: string description: "Encryption_algorithm exact match (case-insensitive)" encryption_algorithm__iew: required: false - type: array + type: string description: "Encryption_algorithm ends with (case-insensitive)" + encryption_algorithm__iregex: + required: false + type: string + description: "Encryption_algorithm" encryption_algorithm__isw: required: false - type: array + type: string description: "Encryption_algorithm starts with (case-sensitive)" encryption_algorithm__n: required: false - type: array + type: string description: "Encryption_algorithm not equal to" encryption_algorithm__nic: required: false - type: array + type: string description: "Encryption_algorithm does not contain (case-insensitive)" encryption_algorithm__nie: required: false - type: array + type: string description: "Encryption_algorithm inverse exact match (case-insensitive)" encryption_algorithm__niew: required: false - type: array + type: string description: "Encryption_algorithm does not end with (case-insensitive)" encryption_algorithm__nisw: required: false - type: array + type: string description: "Encryption_algorithm does not start with (case-sensitive)" + encryption_algorithm__regex: + required: false + type: string + description: "Encryption_algorithm" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -194,67 +218,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" ipsec_policy: required: false - type: array + type: string description: "IPSec policy (name)" ipsec_policy__n: required: false - type: array + type: string description: "Ipsec_policy not equal to" ipsec_policy_id: required: false - type: array + type: integer description: "IPSec policy (ID)" ipsec_policy_id__n: required: false - type: array + type: integer description: "Ipsec_policy_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -266,7 +290,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -274,40 +298,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -316,13 +348,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" sa_lifetime_data: required: false - type: array + type: integer description: "Sa_lifetime_data" sa_lifetime_data__empty: required: false @@ -330,27 +394,27 @@ parameters: description: "Sa_lifetime_data is empty/null (boolean)" sa_lifetime_data__gt: required: false - type: array + type: integer description: "Sa_lifetime_data greater than" sa_lifetime_data__gte: required: false - type: array + type: integer description: "Sa_lifetime_data greater than or equal to" sa_lifetime_data__lt: required: false - type: array + type: integer description: "Sa_lifetime_data less than" sa_lifetime_data__lte: required: false - type: array + type: integer description: "Sa_lifetime_data less than or equal to" sa_lifetime_data__n: required: false - type: array + type: integer description: "Sa_lifetime_data not equal to" sa_lifetime_seconds: required: false - type: array + type: integer description: "Sa_lifetime_seconds" sa_lifetime_seconds__empty: required: false @@ -358,39 +422,43 @@ parameters: description: "Sa_lifetime_seconds is empty/null (boolean)" sa_lifetime_seconds__gt: required: false - type: array + type: integer description: "Sa_lifetime_seconds greater than" sa_lifetime_seconds__gte: required: false - type: array + type: integer description: "Sa_lifetime_seconds greater than or equal to" sa_lifetime_seconds__lt: required: false - type: array + type: integer description: "Sa_lifetime_seconds less than" sa_lifetime_seconds__lte: required: false - type: array + type: integer description: "Sa_lifetime_seconds less than or equal to" sa_lifetime_seconds__n: required: false - type: array + type: integer description: "Sa_lifetime_seconds not equal to" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.vpn.l2vpn_terminations.yaml b/actions/get.vpn.l2vpn_terminations.yaml index 1fc0b76c..04e0bbfd 100644 --- a/actions/get.vpn.l2vpn_terminations.yaml +++ b/actions/get.vpn.l2vpn_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of L2VPN termination objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. assigned_object_id: required: false - type: array + type: integer description: "Assigned_object_id" assigned_object_id__empty: required: false @@ -30,23 +30,23 @@ parameters: description: "Assigned_object_id is empty/null (boolean)" assigned_object_id__gt: required: false - type: array + type: integer description: "Assigned_object_id greater than" assigned_object_id__gte: required: false - type: array + type: integer description: "Assigned_object_id greater than or equal to" assigned_object_id__lt: required: false - type: array + type: integer description: "Assigned_object_id less than" assigned_object_id__lte: required: false - type: array + type: integer description: "Assigned_object_id less than or equal to" assigned_object_id__n: required: false - type: array + type: integer description: "Assigned_object_id not equal to" assigned_object_type: required: false @@ -56,33 +56,41 @@ parameters: required: false type: string description: "Assigned_object_type not equal to" + assigned_object_type_id: + required: false + type: integer + description: "Assigned_object_type_id" + assigned_object_type_id__n: + required: false + type: integer + description: "Assigned_object_type_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -90,23 +98,23 @@ parameters: description: "Created_by_request" device: required: false - type: array + type: string description: "Device (name)" device__n: required: false - type: array + type: string description: "Device not equal to" device_id: required: false - type: array + type: integer description: "Device (ID)" device_id__n: required: false - type: array + type: integer description: "Device_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -114,83 +122,83 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface: required: false - type: array + type: string description: "Interface (name)" interface__n: required: false - type: array + type: string description: "Interface not equal to" interface_id: required: false - type: array + type: integer description: "Interface (ID)" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" l2vpn: required: false - type: array + type: string description: "L2VPN (slug)" l2vpn__n: required: false - type: array + type: string description: "L2vpn not equal to" l2vpn_id: required: false - type: array + type: integer description: "L2VPN (ID)" l2vpn_id__n: required: false - type: array + type: integer description: "L2vpn_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -214,35 +222,39 @@ parameters: description: "Search" region: required: false - type: array + type: string description: "Region" region_id: required: false - type: array + type: integer description: "Region_id" site: required: false - type: array + type: string description: "Site" site_id: required: false - type: array + type: integer description: "Site_id" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false @@ -250,35 +262,35 @@ parameters: description: "Updated_by_request" virtual_machine: required: false - type: array + type: string description: "Virtual machine (name)" virtual_machine__n: required: false - type: array + type: string description: "Virtual_machine not equal to" virtual_machine_id: required: false - type: array + type: integer description: "Virtual machine (ID)" virtual_machine_id__n: required: false - type: array + type: integer description: "Virtual_machine_id not equal to" vlan: required: false - type: array + type: string description: "VLAN (name)" vlan__n: required: false - type: array + type: string description: "Vlan not equal to" vlan_id: required: false - type: array + type: integer description: "VLAN (ID)" vlan_id__n: required: false - type: array + type: integer description: "Vlan_id not equal to" vlan_vid: required: false @@ -310,19 +322,19 @@ parameters: description: "Vlan_vid not equal to" vminterface: required: false - type: array + type: string description: "VM interface (name)" vminterface__n: required: false - type: array + type: string description: "Vminterface not equal to" vminterface_id: required: false - type: array + type: integer description: "VM Interface (ID)" vminterface_id__n: required: false - type: array + type: integer description: "Vminterface_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.vpn.l2vpns.yaml b/actions/get.vpn.l2vpns.yaml index 03b3e0bd..83aef117 100644 --- a/actions/get.vpn.l2vpns.yaml +++ b/actions/get.vpn.l2vpns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of L2VPN objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,59 +86,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" export_target: required: false - type: array + type: string description: "Export target (name)" export_target__n: required: false - type: array + type: string description: "Export_target not equal to" export_target_id: required: false - type: array + type: integer description: "Export target" export_target_id__n: required: false - type: array + type: integer description: "Export_target_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -146,27 +154,27 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" identifier: required: false - type: array + type: integer description: "Identifier" identifier__empty: required: false @@ -174,67 +182,67 @@ parameters: description: "Identifier is empty/null (boolean)" identifier__gt: required: false - type: array + type: integer description: "Identifier greater than" identifier__gte: required: false - type: array + type: integer description: "Identifier greater than or equal to" identifier__lt: required: false - type: array + type: integer description: "Identifier less than" identifier__lte: required: false - type: array + type: integer description: "Identifier less than or equal to" identifier__n: required: false - type: array + type: integer description: "Identifier not equal to" import_target: required: false - type: array + type: string description: "Import target (name)" import_target__n: required: false - type: array + type: string description: "Import_target not equal to" import_target_id: required: false - type: array + type: integer description: "Import target" import_target_id__n: required: false - type: array + type: integer description: "Import_target_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -246,7 +254,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -254,40 +262,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -296,13 +312,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -310,43 +358,55 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -354,91 +414,99 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" type: required: false - type: array + type: string description: "Type" type__empty: required: false @@ -446,40 +514,48 @@ parameters: description: "Type is empty/null (boolean)" type__ic: required: false - type: array + type: string description: "Type contains (case-insensitive)" type__ie: required: false - type: array + type: string description: "Type exact match (case-insensitive)" type__iew: required: false - type: array + type: string description: "Type ends with (case-insensitive)" + type__iregex: + required: false + type: string + description: "Type" type__isw: required: false - type: array + type: string description: "Type starts with (case-sensitive)" type__n: required: false - type: array + type: string description: "Type not equal to" type__nic: required: false - type: array + type: string description: "Type does not contain (case-insensitive)" type__nie: required: false - type: array + type: string description: "Type inverse exact match (case-insensitive)" type__niew: required: false - type: array + type: string description: "Type does not end with (case-insensitive)" type__nisw: required: false - type: array + type: string description: "Type does not start with (case-sensitive)" + type__regex: + required: false + type: string + description: "Type" updated_by_request: required: false type: string diff --git a/actions/get.vpn.tunnel_groups.yaml b/actions/get.vpn.tunnel_groups.yaml index 7801fe7e..8eaa3bcf 100644 --- a/actions/get.vpn.tunnel_groups.yaml +++ b/actions/get.vpn.tunnel_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of tunnel group objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,43 +86,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -130,51 +138,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -186,7 +194,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -194,40 +202,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -236,13 +252,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -250,55 +298,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.vpn.tunnel_terminations.yaml b/actions/get.vpn.tunnel_terminations.yaml index 5bfb0ea6..fb0199ae 100644 --- a/actions/get.vpn.tunnel_terminations.yaml +++ b/actions/get.vpn.tunnel_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of tunnel termination objects." enabled: true entry_point: run.py @@ -22,31 +22,31 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -54,7 +54,7 @@ parameters: description: "Created_by_request" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -62,67 +62,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface: required: false - type: array + type: string description: "Interface (name)" interface__n: required: false - type: array + type: string description: "Interface not equal to" interface_id: required: false - type: array + type: integer description: "Interface (ID)" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -142,11 +142,11 @@ parameters: description: "Which field to use when ordering the results." outside_ip_id: required: false - type: array + type: integer description: "Outside IP (ID)" outside_ip_id__n: required: false - type: array + type: integer description: "Outside_ip_id not equal to" q: required: false @@ -154,7 +154,7 @@ parameters: description: "Search" role: required: false - type: array + type: string description: "Role" role__empty: required: false @@ -162,59 +162,71 @@ parameters: description: "Role is empty/null (boolean)" role__ic: required: false - type: array + type: string description: "Role contains (case-insensitive)" role__ie: required: false - type: array + type: string description: "Role exact match (case-insensitive)" role__iew: required: false - type: array + type: string description: "Role ends with (case-insensitive)" + role__iregex: + required: false + type: string + description: "Role" role__isw: required: false - type: array + type: string description: "Role starts with (case-sensitive)" role__n: required: false - type: array + type: string description: "Role not equal to" role__nic: required: false - type: array + type: string description: "Role does not contain (case-insensitive)" role__nie: required: false - type: array + type: string description: "Role inverse exact match (case-insensitive)" role__niew: required: false - type: array + type: string description: "Role does not end with (case-insensitive)" role__nisw: required: false - type: array + type: string description: "Role does not start with (case-sensitive)" + role__regex: + required: false + type: string + description: "Role" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" termination_id: required: false - type: array + type: integer description: "Termination_id" termination_id__empty: required: false @@ -222,23 +234,23 @@ parameters: description: "Termination_id is empty/null (boolean)" termination_id__gt: required: false - type: array + type: integer description: "Termination_id greater than" termination_id__gte: required: false - type: array + type: integer description: "Termination_id greater than or equal to" termination_id__lt: required: false - type: array + type: integer description: "Termination_id less than" termination_id__lte: required: false - type: array + type: integer description: "Termination_id less than or equal to" termination_id__n: required: false - type: array + type: integer description: "Termination_id not equal to" termination_type: required: false @@ -250,19 +262,19 @@ parameters: description: "Termination_type not equal to" tunnel: required: false - type: array + type: string description: "Tunnel (name)" tunnel__n: required: false - type: array + type: string description: "Tunnel not equal to" tunnel_id: required: false - type: array + type: integer description: "Tunnel (ID)" tunnel_id__n: required: false - type: array + type: integer description: "Tunnel_id not equal to" updated_by_request: required: false @@ -270,19 +282,19 @@ parameters: description: "Updated_by_request" vminterface: required: false - type: array + type: string description: "VM interface (name)" vminterface__n: required: false - type: array + type: string description: "Vminterface not equal to" vminterface_id: required: false - type: array + type: integer description: "VM interface (ID)" vminterface_id__n: required: false - type: array + type: integer description: "Vminterface_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.vpn.tunnels.yaml b/actions/get.vpn.tunnels.yaml index 13405ec9..74333263 100644 --- a/actions/get.vpn.tunnels.yaml +++ b/actions/get.vpn.tunnels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of tunnel objects." enabled: true entry_point: run.py @@ -22,55 +22,55 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. contact: required: false - type: array + type: integer description: "Contact" contact__n: required: false - type: array + type: integer description: "Contact not equal to" contact_group: required: false - type: array + type: string description: "Contact_group" contact_group__n: required: false - type: array + type: string description: "Contact_group not equal to" contact_role: required: false - type: array + type: integer description: "Contact Role" contact_role__n: required: false - type: array + type: integer description: "Contact_role not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -78,7 +78,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -86,43 +86,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" encapsulation: required: false - type: array + type: string description: "Encapsulation" encapsulation__empty: required: false @@ -130,59 +138,67 @@ parameters: description: "Encapsulation is empty/null (boolean)" encapsulation__ic: required: false - type: array + type: string description: "Encapsulation contains (case-insensitive)" encapsulation__ie: required: false - type: array + type: string description: "Encapsulation exact match (case-insensitive)" encapsulation__iew: required: false - type: array + type: string description: "Encapsulation ends with (case-insensitive)" + encapsulation__iregex: + required: false + type: string + description: "Encapsulation" encapsulation__isw: required: false - type: array + type: string description: "Encapsulation starts with (case-sensitive)" encapsulation__n: required: false - type: array + type: string description: "Encapsulation not equal to" encapsulation__nic: required: false - type: array + type: string description: "Encapsulation does not contain (case-insensitive)" encapsulation__nie: required: false - type: array + type: string description: "Encapsulation inverse exact match (case-insensitive)" encapsulation__niew: required: false - type: array + type: string description: "Encapsulation does not end with (case-insensitive)" encapsulation__nisw: required: false - type: array + type: string description: "Encapsulation does not start with (case-sensitive)" + encapsulation__regex: + required: false + type: string + description: "Encapsulation" group: required: false - type: array + type: string description: "Tunnel group (slug)" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: integer description: "Tunnel group (ID)" group_id__n: required: false - type: array + type: integer description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -190,67 +206,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" ipsec_profile: required: false - type: array + type: string description: "IPSec profile (name)" ipsec_profile__n: required: false - type: array + type: string description: "Ipsec_profile not equal to" ipsec_profile_id: required: false - type: array + type: integer description: "IPSec profile (ID)" ipsec_profile_id__n: required: false - type: array + type: integer description: "Ipsec_profile_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -262,7 +278,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -270,40 +286,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -312,13 +336,49 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -326,91 +386,99 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" tunnel_id: required: false - type: array + type: integer description: "Tunnel_id" tunnel_id__empty: required: false @@ -418,23 +486,23 @@ parameters: description: "Tunnel_id is empty/null (boolean)" tunnel_id__gt: required: false - type: array + type: integer description: "Tunnel_id greater than" tunnel_id__gte: required: false - type: array + type: integer description: "Tunnel_id greater than or equal to" tunnel_id__lt: required: false - type: array + type: integer description: "Tunnel_id less than" tunnel_id__lte: required: false - type: array + type: integer description: "Tunnel_id less than or equal to" tunnel_id__n: required: false - type: array + type: integer description: "Tunnel_id not equal to" updated_by_request: required: false diff --git a/actions/get.wireless.wireless_lan_groups.yaml b/actions/get.wireless.wireless_lan_groups.yaml index 8f756c63..bee2e1d5 100644 --- a/actions/get.wireless.wireless_lan_groups.yaml +++ b/actions/get.wireless.wireless_lan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of wireless LAN group objects." enabled: true entry_point: run.py @@ -22,47 +22,47 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. ancestor: required: false - type: array + type: string description: "Ancestor" ancestor__n: required: false - type: array + type: string description: "Ancestor not equal to" ancestor_id: required: false - type: array + type: string description: "Ancestor_id" ancestor_id__n: required: false - type: array + type: string description: "Ancestor_id not equal to" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -70,7 +70,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -78,43 +78,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -122,51 +130,51 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -178,7 +186,7 @@ parameters: description: "Modified_by_request" name: required: false - type: array + type: string description: "Name" name__empty: required: false @@ -186,40 +194,48 @@ parameters: description: "Name is empty/null (boolean)" name__ic: required: false - type: array + type: string description: "Name contains (case-insensitive)" name__ie: required: false - type: array + type: string description: "Name exact match (case-insensitive)" name__iew: required: false - type: array + type: string description: "Name ends with (case-insensitive)" + name__iregex: + required: false + type: string + description: "Name" name__isw: required: false - type: array + type: string description: "Name starts with (case-sensitive)" name__n: required: false - type: array + type: string description: "Name not equal to" name__nic: required: false - type: array + type: string description: "Name does not contain (case-insensitive)" name__nie: required: false - type: array + type: string description: "Name inverse exact match (case-insensitive)" name__niew: required: false - type: array + type: string description: "Name does not end with (case-insensitive)" name__nisw: required: false - type: array + type: string description: "Name does not start with (case-sensitive)" + name__regex: + required: false + type: string + description: "Name" offset: required: false type: integer @@ -228,21 +244,53 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" parent: required: false - type: array + type: string description: "Parent" parent__n: required: false - type: array + type: string description: "Parent not equal to" parent_id: required: false - type: array + type: integer description: "Parent_id" parent_id__n: required: false - type: array + type: integer description: "Parent_id not equal to" q: required: false @@ -250,7 +298,7 @@ parameters: description: "Search" slug: required: false - type: array + type: string description: "Slug" slug__empty: required: false @@ -258,55 +306,67 @@ parameters: description: "Slug is empty/null (boolean)" slug__ic: required: false - type: array + type: string description: "Slug contains (case-insensitive)" slug__ie: required: false - type: array + type: string description: "Slug exact match (case-insensitive)" slug__iew: required: false - type: array + type: string description: "Slug ends with (case-insensitive)" + slug__iregex: + required: false + type: string + description: "Slug" slug__isw: required: false - type: array + type: string description: "Slug starts with (case-sensitive)" slug__n: required: false - type: array + type: string description: "Slug not equal to" slug__nic: required: false - type: array + type: string description: "Slug does not contain (case-insensitive)" slug__nie: required: false - type: array + type: string description: "Slug inverse exact match (case-insensitive)" slug__niew: required: false - type: array + type: string description: "Slug does not end with (case-insensitive)" slug__nisw: required: false - type: array + type: string description: "Slug does not start with (case-sensitive)" + slug__regex: + required: false + type: string + description: "Slug" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" updated_by_request: required: false diff --git a/actions/get.wireless.wireless_lans.yaml b/actions/get.wireless.wireless_lans.yaml index e577961b..b1ee6978 100644 --- a/actions/get.wireless.wireless_lans.yaml +++ b/actions/get.wireless.wireless_lans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of wireless LAN objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. auth_cipher: required: false - type: array + type: string description: "Auth_cipher" auth_cipher__empty: required: false @@ -30,43 +30,51 @@ parameters: description: "Auth_cipher is empty/null (boolean)" auth_cipher__ic: required: false - type: array + type: string description: "Auth_cipher contains (case-insensitive)" auth_cipher__ie: required: false - type: array + type: string description: "Auth_cipher exact match (case-insensitive)" auth_cipher__iew: required: false - type: array + type: string description: "Auth_cipher ends with (case-insensitive)" + auth_cipher__iregex: + required: false + type: string + description: "Auth_cipher" auth_cipher__isw: required: false - type: array + type: string description: "Auth_cipher starts with (case-sensitive)" auth_cipher__n: required: false - type: array + type: string description: "Auth_cipher not equal to" auth_cipher__nic: required: false - type: array + type: string description: "Auth_cipher does not contain (case-insensitive)" auth_cipher__nie: required: false - type: array + type: string description: "Auth_cipher inverse exact match (case-insensitive)" auth_cipher__niew: required: false - type: array + type: string description: "Auth_cipher does not end with (case-insensitive)" auth_cipher__nisw: required: false - type: array + type: string description: "Auth_cipher does not start with (case-sensitive)" + auth_cipher__regex: + required: false + type: string + description: "Auth_cipher" auth_psk: required: false - type: array + type: string description: "Auth_psk" auth_psk__empty: required: false @@ -74,43 +82,51 @@ parameters: description: "Auth_psk is empty/null (boolean)" auth_psk__ic: required: false - type: array + type: string description: "Auth_psk contains (case-insensitive)" auth_psk__ie: required: false - type: array + type: string description: "Auth_psk exact match (case-insensitive)" auth_psk__iew: required: false - type: array + type: string description: "Auth_psk ends with (case-insensitive)" + auth_psk__iregex: + required: false + type: string + description: "Auth_psk" auth_psk__isw: required: false - type: array + type: string description: "Auth_psk starts with (case-sensitive)" auth_psk__n: required: false - type: array + type: string description: "Auth_psk not equal to" auth_psk__nic: required: false - type: array + type: string description: "Auth_psk does not contain (case-insensitive)" auth_psk__nie: required: false - type: array + type: string description: "Auth_psk inverse exact match (case-insensitive)" auth_psk__niew: required: false - type: array + type: string description: "Auth_psk does not end with (case-insensitive)" auth_psk__nisw: required: false - type: array + type: string description: "Auth_psk does not start with (case-sensitive)" + auth_psk__regex: + required: false + type: string + description: "Auth_psk" auth_type: required: false - type: array + type: string description: "Auth_type" auth_type__empty: required: false @@ -118,67 +134,75 @@ parameters: description: "Auth_type is empty/null (boolean)" auth_type__ic: required: false - type: array + type: string description: "Auth_type contains (case-insensitive)" auth_type__ie: required: false - type: array + type: string description: "Auth_type exact match (case-insensitive)" auth_type__iew: required: false - type: array + type: string description: "Auth_type ends with (case-insensitive)" + auth_type__iregex: + required: false + type: string + description: "Auth_type" auth_type__isw: required: false - type: array + type: string description: "Auth_type starts with (case-sensitive)" auth_type__n: required: false - type: array + type: string description: "Auth_type not equal to" auth_type__nic: required: false - type: array + type: string description: "Auth_type does not contain (case-insensitive)" auth_type__nie: required: false - type: array + type: string description: "Auth_type inverse exact match (case-insensitive)" auth_type__niew: required: false - type: array + type: string description: "Auth_type does not end with (case-insensitive)" auth_type__nisw: required: false - type: array + type: string description: "Auth_type does not start with (case-sensitive)" + auth_type__regex: + required: false + type: string + description: "Auth_type" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -186,7 +210,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -194,59 +218,67 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" group: required: false - type: array + type: string description: "Group" group__n: required: false - type: array + type: string description: "Group not equal to" group_id: required: false - type: array + type: string description: "Group_id" group_id__n: required: false - type: array + type: string description: "Group_id not equal to" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -254,59 +286,59 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_id: required: false - type: array + type: integer description: "Interface_id" interface_id__n: required: false - type: array + type: integer description: "Interface_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -314,19 +346,19 @@ parameters: description: "Number of results to return per page." location: required: false - type: array + type: string description: "Location" location__n: required: false - type: array + type: string description: "Location not equal to" location_id: required: false - type: array + type: string description: "Location_id" location_id__n: required: false - type: array + type: string description: "Location_id not equal to" modified_by_request: required: false @@ -340,29 +372,61 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" region: required: false - type: array + type: string description: "Region" region__n: required: false - type: array + type: string description: "Region not equal to" region_id: required: false - type: array + type: string description: "Region_id" region_id__n: required: false - type: array + type: string description: "Region_id not equal to" scope_id: required: false - type: array + type: integer description: "Scope_id" scope_id__empty: required: false @@ -370,23 +434,23 @@ parameters: description: "Scope_id is empty/null (boolean)" scope_id__gt: required: false - type: array + type: integer description: "Scope_id greater than" scope_id__gte: required: false - type: array + type: integer description: "Scope_id greater than or equal to" scope_id__lt: required: false - type: array + type: integer description: "Scope_id less than" scope_id__lte: required: false - type: array + type: integer description: "Scope_id less than or equal to" scope_id__n: required: false - type: array + type: integer description: "Scope_id not equal to" scope_type: required: false @@ -398,39 +462,39 @@ parameters: description: "Scope_type not equal to" site: required: false - type: array + type: string description: "Site (slug)" site__n: required: false - type: array + type: string description: "Site not equal to" site_group: required: false - type: array + type: string description: "Site_group" site_group__n: required: false - type: array + type: string description: "Site_group not equal to" site_group_id: required: false - type: array + type: string description: "Site_group_id" site_group_id__n: required: false - type: array + type: string description: "Site_group_id not equal to" site_id: required: false - type: array + type: integer description: "Site (ID)" site_id__n: required: false - type: array + type: integer description: "Site_id not equal to" ssid: required: false - type: array + type: string description: "Ssid" ssid__empty: required: false @@ -438,43 +502,55 @@ parameters: description: "Ssid is empty/null (boolean)" ssid__ic: required: false - type: array + type: string description: "Ssid contains (case-insensitive)" ssid__ie: required: false - type: array + type: string description: "Ssid exact match (case-insensitive)" ssid__iew: required: false - type: array + type: string description: "Ssid ends with (case-insensitive)" + ssid__iregex: + required: false + type: string + description: "Ssid" ssid__isw: required: false - type: array + type: string description: "Ssid starts with (case-sensitive)" ssid__n: required: false - type: array + type: string description: "Ssid not equal to" ssid__nic: required: false - type: array + type: string description: "Ssid does not contain (case-insensitive)" ssid__nie: required: false - type: array + type: string description: "Ssid inverse exact match (case-insensitive)" ssid__niew: required: false - type: array + type: string description: "Ssid does not end with (case-insensitive)" ssid__nisw: required: false - type: array + type: string description: "Ssid does not start with (case-sensitive)" + ssid__regex: + required: false + type: string + description: "Ssid" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -482,87 +558,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false @@ -570,11 +654,11 @@ parameters: description: "Updated_by_request" vlan_id: required: false - type: array + type: integer description: "Vlan_id" vlan_id__n: required: false - type: array + type: integer description: "Vlan_id not equal to" save_in_key_store: type: boolean diff --git a/actions/get.wireless.wireless_links.yaml b/actions/get.wireless.wireless_links.yaml index 764f4739..d2559c95 100644 --- a/actions/get.wireless.wireless_links.yaml +++ b/actions/get.wireless.wireless_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Get a list of wireless link objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. auth_cipher: required: false - type: array + type: string description: "Auth_cipher" auth_cipher__empty: required: false @@ -30,43 +30,51 @@ parameters: description: "Auth_cipher is empty/null (boolean)" auth_cipher__ic: required: false - type: array + type: string description: "Auth_cipher contains (case-insensitive)" auth_cipher__ie: required: false - type: array + type: string description: "Auth_cipher exact match (case-insensitive)" auth_cipher__iew: required: false - type: array + type: string description: "Auth_cipher ends with (case-insensitive)" + auth_cipher__iregex: + required: false + type: string + description: "Auth_cipher" auth_cipher__isw: required: false - type: array + type: string description: "Auth_cipher starts with (case-sensitive)" auth_cipher__n: required: false - type: array + type: string description: "Auth_cipher not equal to" auth_cipher__nic: required: false - type: array + type: string description: "Auth_cipher does not contain (case-insensitive)" auth_cipher__nie: required: false - type: array + type: string description: "Auth_cipher inverse exact match (case-insensitive)" auth_cipher__niew: required: false - type: array + type: string description: "Auth_cipher does not end with (case-insensitive)" auth_cipher__nisw: required: false - type: array + type: string description: "Auth_cipher does not start with (case-sensitive)" + auth_cipher__regex: + required: false + type: string + description: "Auth_cipher" auth_psk: required: false - type: array + type: string description: "Auth_psk" auth_psk__empty: required: false @@ -74,43 +82,51 @@ parameters: description: "Auth_psk is empty/null (boolean)" auth_psk__ic: required: false - type: array + type: string description: "Auth_psk contains (case-insensitive)" auth_psk__ie: required: false - type: array + type: string description: "Auth_psk exact match (case-insensitive)" auth_psk__iew: required: false - type: array + type: string description: "Auth_psk ends with (case-insensitive)" + auth_psk__iregex: + required: false + type: string + description: "Auth_psk" auth_psk__isw: required: false - type: array + type: string description: "Auth_psk starts with (case-sensitive)" auth_psk__n: required: false - type: array + type: string description: "Auth_psk not equal to" auth_psk__nic: required: false - type: array + type: string description: "Auth_psk does not contain (case-insensitive)" auth_psk__nie: required: false - type: array + type: string description: "Auth_psk inverse exact match (case-insensitive)" auth_psk__niew: required: false - type: array + type: string description: "Auth_psk does not end with (case-insensitive)" auth_psk__nisw: required: false - type: array + type: string description: "Auth_psk does not start with (case-sensitive)" + auth_psk__regex: + required: false + type: string + description: "Auth_psk" auth_type: required: false - type: array + type: string description: "Auth_type" auth_type__empty: required: false @@ -118,67 +134,75 @@ parameters: description: "Auth_type is empty/null (boolean)" auth_type__ic: required: false - type: array + type: string description: "Auth_type contains (case-insensitive)" auth_type__ie: required: false - type: array + type: string description: "Auth_type exact match (case-insensitive)" auth_type__iew: required: false - type: array + type: string description: "Auth_type ends with (case-insensitive)" + auth_type__iregex: + required: false + type: string + description: "Auth_type" auth_type__isw: required: false - type: array + type: string description: "Auth_type starts with (case-sensitive)" auth_type__n: required: false - type: array + type: string description: "Auth_type not equal to" auth_type__nic: required: false - type: array + type: string description: "Auth_type does not contain (case-insensitive)" auth_type__nie: required: false - type: array + type: string description: "Auth_type inverse exact match (case-insensitive)" auth_type__niew: required: false - type: array + type: string description: "Auth_type does not end with (case-insensitive)" auth_type__nisw: required: false - type: array + type: string description: "Auth_type does not start with (case-sensitive)" + auth_type__regex: + required: false + type: string + description: "Auth_type" created: required: false - type: array + type: string description: "Created" created__empty: required: false - type: array + type: string description: "Created is empty/null (boolean)" created__gt: required: false - type: array + type: string description: "Created greater than" created__gte: required: false - type: array + type: string description: "Created greater than or equal to" created__lt: required: false - type: array + type: string description: "Created less than" created__lte: required: false - type: array + type: string description: "Created less than or equal to" created__n: required: false - type: array + type: string description: "Created not equal to" created_by_request: required: false @@ -186,7 +210,7 @@ parameters: description: "Created_by_request" description: required: false - type: array + type: string description: "Description" description__empty: required: false @@ -194,43 +218,51 @@ parameters: description: "Description is empty/null (boolean)" description__ic: required: false - type: array + type: string description: "Description contains (case-insensitive)" description__ie: required: false - type: array + type: string description: "Description exact match (case-insensitive)" description__iew: required: false - type: array + type: string description: "Description ends with (case-insensitive)" + description__iregex: + required: false + type: string + description: "Description" description__isw: required: false - type: array + type: string description: "Description starts with (case-sensitive)" description__n: required: false - type: array + type: string description: "Description not equal to" description__nic: required: false - type: array + type: string description: "Description does not contain (case-insensitive)" description__nie: required: false - type: array + type: string description: "Description inverse exact match (case-insensitive)" description__niew: required: false - type: array + type: string description: "Description does not end with (case-insensitive)" description__nisw: required: false - type: array + type: string description: "Description does not start with (case-sensitive)" + description__regex: + required: false + type: string + description: "Description" distance: required: false - type: array + type: integer description: "Distance" distance__empty: required: false @@ -238,23 +270,23 @@ parameters: description: "Distance is empty/null (boolean)" distance__gt: required: false - type: array + type: integer description: "Distance greater than" distance__gte: required: false - type: array + type: integer description: "Distance greater than or equal to" distance__lt: required: false - type: array + type: integer description: "Distance less than" distance__lte: required: false - type: array + type: integer description: "Distance less than or equal to" distance__n: required: false - type: array + type: integer description: "Distance not equal to" distance_unit: required: false @@ -263,9 +295,57 @@ parameters: * `m` - Meters * `mi` - Miles * `ft` - Feet" + distance_unit__empty: + required: false + type: boolean + description: "Distance_unit is empty/null (boolean)" + distance_unit__ic: + required: false + type: string + description: "Distance_unit contains (case-insensitive)" + distance_unit__ie: + required: false + type: string + description: "Distance_unit exact match (case-insensitive)" + distance_unit__iew: + required: false + type: string + description: "Distance_unit ends with (case-insensitive)" + distance_unit__iregex: + required: false + type: string + description: "Distance_unit" + distance_unit__isw: + required: false + type: string + description: "Distance_unit starts with (case-sensitive)" + distance_unit__n: + required: false + type: string + description: "Distance_unit not equal to" + distance_unit__nic: + required: false + type: string + description: "Distance_unit does not contain (case-insensitive)" + distance_unit__nie: + required: false + type: string + description: "Distance_unit inverse exact match (case-insensitive)" + distance_unit__niew: + required: false + type: string + description: "Distance_unit does not end with (case-insensitive)" + distance_unit__nisw: + required: false + type: string + description: "Distance_unit does not start with (case-sensitive)" + distance_unit__regex: + required: false + type: string + description: "Distance_unit" id: required: false - type: array + type: integer description: "Id" id__empty: required: false @@ -273,67 +353,67 @@ parameters: description: "Id is empty/null (boolean)" id__gt: required: false - type: array + type: integer description: "Id greater than" id__gte: required: false - type: array + type: integer description: "Id greater than or equal to" id__lt: required: false - type: array + type: integer description: "Id less than" id__lte: required: false - type: array + type: integer description: "Id less than or equal to" id__n: required: false - type: array + type: integer description: "Id not equal to" interface_a_id: required: false - type: array + type: integer description: "Interface_a_id" interface_a_id__n: required: false - type: array + type: integer description: "Interface_a_id not equal to" interface_b_id: required: false - type: array + type: integer description: "Interface_b_id" interface_b_id__n: required: false - type: array + type: integer description: "Interface_b_id not equal to" last_updated: required: false - type: array + type: string description: "Last_updated" last_updated__empty: required: false - type: array + type: string description: "Last_updated is empty/null (boolean)" last_updated__gt: required: false - type: array + type: string description: "Last_updated greater than" last_updated__gte: required: false - type: array + type: string description: "Last_updated greater than or equal to" last_updated__lt: required: false - type: array + type: string description: "Last_updated less than" last_updated__lte: required: false - type: array + type: string description: "Last_updated less than or equal to" last_updated__n: required: false - type: array + type: string description: "Last_updated not equal to" limit: required: false @@ -351,13 +431,45 @@ parameters: required: false type: string description: "Which field to use when ordering the results." + owner: + required: false + type: string + description: "Owner (name)" + owner__n: + required: false + type: string + description: "Owner not equal to" + owner_group: + required: false + type: string + description: "Owner Group (name)" + owner_group__n: + required: false + type: string + description: "Owner_group not equal to" + owner_group_id: + required: false + type: integer + description: "Owner Group (ID)" + owner_group_id__n: + required: false + type: integer + description: "Owner_group_id not equal to" + owner_id: + required: false + type: integer + description: "Owner (ID)" + owner_id__n: + required: false + type: integer + description: "Owner_id not equal to" q: required: false type: string description: "Search" ssid: required: false - type: array + type: string description: "Ssid" ssid__empty: required: false @@ -365,43 +477,55 @@ parameters: description: "Ssid is empty/null (boolean)" ssid__ic: required: false - type: array + type: string description: "Ssid contains (case-insensitive)" ssid__ie: required: false - type: array + type: string description: "Ssid exact match (case-insensitive)" ssid__iew: required: false - type: array + type: string description: "Ssid ends with (case-insensitive)" + ssid__iregex: + required: false + type: string + description: "Ssid" ssid__isw: required: false - type: array + type: string description: "Ssid starts with (case-sensitive)" ssid__n: required: false - type: array + type: string description: "Ssid not equal to" ssid__nic: required: false - type: array + type: string description: "Ssid does not contain (case-insensitive)" ssid__nie: required: false - type: array + type: string description: "Ssid inverse exact match (case-insensitive)" ssid__niew: required: false - type: array + type: string description: "Ssid does not end with (case-insensitive)" ssid__nisw: required: false - type: array + type: string description: "Ssid does not start with (case-sensitive)" + ssid__regex: + required: false + type: string + description: "Ssid" + start: + required: false + type: integer + description: "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." status: required: false - type: array + type: string description: "Status" status__empty: required: false @@ -409,87 +533,95 @@ parameters: description: "Status is empty/null (boolean)" status__ic: required: false - type: array + type: string description: "Status contains (case-insensitive)" status__ie: required: false - type: array + type: string description: "Status exact match (case-insensitive)" status__iew: required: false - type: array + type: string description: "Status ends with (case-insensitive)" + status__iregex: + required: false + type: string + description: "Status" status__isw: required: false - type: array + type: string description: "Status starts with (case-sensitive)" status__n: required: false - type: array + type: string description: "Status not equal to" status__nic: required: false - type: array + type: string description: "Status does not contain (case-insensitive)" status__nie: required: false - type: array + type: string description: "Status inverse exact match (case-insensitive)" status__niew: required: false - type: array + type: string description: "Status does not end with (case-insensitive)" status__nisw: required: false - type: array + type: string description: "Status does not start with (case-sensitive)" + status__regex: + required: false + type: string + description: "Status" tag: required: false - type: array + type: string description: "Tag" tag__n: required: false - type: array + type: string description: "Tag not equal to" tag_id: required: false - type: array + type: integer description: "Tag_id" tag_id__n: required: false - type: array + type: integer description: "Tag_id not equal to" tenant: required: false - type: array + type: string description: "Tenant (slug)" tenant__n: required: false - type: array + type: string description: "Tenant not equal to" tenant_group: required: false - type: array + type: string description: "Tenant_group" tenant_group__n: required: false - type: array + type: string description: "Tenant_group not equal to" tenant_group_id: required: false - type: array + type: string description: "Tenant_group_id" tenant_group_id__n: required: false - type: array + type: string description: "Tenant_group_id not equal to" tenant_id: required: false - type: array + type: integer description: "Tenant (ID)" tenant_id__n: required: false - type: array + type: integer description: "Tenant_id not equal to" updated_by_request: required: false diff --git a/actions/patch.circuits.circuit_group_assignments.yaml b/actions/patch.circuits.circuit_group_assignments.yaml index 5c62df08..61975be5 100644 --- a/actions/patch.circuits.circuit_group_assignments.yaml +++ b/actions/patch.circuits.circuit_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a Circuit group assignment object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. group: required: false - type: object + type: integer description: "Group" member_type: required: false diff --git a/actions/patch.circuits.circuit_groups.yaml b/actions/patch.circuits.circuit_groups.yaml index 3aa1e67f..66aaa732 100644 --- a/actions/patch.circuits.circuit_groups.yaml +++ b/actions/patch.circuits.circuit_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a circuit group object." enabled: true entry_point: run.py @@ -34,8 +34,16 @@ parameters: description: "Description" tenant: required: false - type: object + type: integer description: "Tenant" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.circuits.circuit_terminations.yaml b/actions/patch.circuits.circuit_terminations.yaml index 093a556c..8a5eb61b 100644 --- a/actions/patch.circuits.circuit_terminations.yaml +++ b/actions/patch.circuits.circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a circuit termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. circuit: required: false - type: object + type: integer description: "Circuit" term_side: required: false diff --git a/actions/patch.circuits.circuit_types.yaml b/actions/patch.circuits.circuit_types.yaml index 9f0e1c41..38e66c26 100644 --- a/actions/patch.circuits.circuit_types.yaml +++ b/actions/patch.circuits.circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a circuit type object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.circuits.circuits.yaml b/actions/patch.circuits.circuits.yaml index d28343d4..7ae15cad 100644 --- a/actions/patch.circuits.circuits.yaml +++ b/actions/patch.circuits.circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a circuit object." enabled: true entry_point: run.py @@ -26,15 +26,15 @@ parameters: description: "Circuit ID" provider: required: false - type: object + type: integer description: "Provider" provider_account: required: false - type: object + type: integer description: "Provider account" type: required: false - type: object + type: integer description: "Type" status: required: false @@ -47,7 +47,7 @@ parameters: * `decommissioned` - Decommissioned" tenant: required: false - type: object + type: integer description: "Tenant" install_date: required: false @@ -76,6 +76,10 @@ parameters: * `m` - Meters * `mi` - Miles * `ft` - Feet" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.circuits.provider_accounts.yaml b/actions/patch.circuits.provider_accounts.yaml index 01e508f6..9de9752d 100644 --- a/actions/patch.circuits.provider_accounts.yaml +++ b/actions/patch.circuits.provider_accounts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a provider account object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. provider: required: false - type: object + type: integer description: "Provider" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.circuits.provider_networks.yaml b/actions/patch.circuits.provider_networks.yaml index 0b0f0695..f320f7b2 100644 --- a/actions/patch.circuits.provider_networks.yaml +++ b/actions/patch.circuits.provider_networks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a provider network object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. provider: required: false - type: object + type: integer description: "Provider" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.circuits.providers.yaml b/actions/patch.circuits.providers.yaml index 70f2dd1e..ea96ef23 100644 --- a/actions/patch.circuits.providers.yaml +++ b/actions/patch.circuits.providers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a provider object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.circuits.virtual_circuit_terminations.yaml b/actions/patch.circuits.virtual_circuit_terminations.yaml index 8dabbe80..5761ef09 100644 --- a/actions/patch.circuits.virtual_circuit_terminations.yaml +++ b/actions/patch.circuits.virtual_circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a virtual circuit termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_circuit: required: false - type: object + type: integer description: "Virtual circuit" role: required: false @@ -32,7 +32,7 @@ parameters: * `spoke` - Spoke" interface: required: false - type: object + type: integer description: "Interface" description: required: false diff --git a/actions/patch.circuits.virtual_circuit_types.yaml b/actions/patch.circuits.virtual_circuit_types.yaml index 29fca1af..b4b0ab7c 100644 --- a/actions/patch.circuits.virtual_circuit_types.yaml +++ b/actions/patch.circuits.virtual_circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a virtual circuit type object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.circuits.virtual_circuits.yaml b/actions/patch.circuits.virtual_circuits.yaml index ddece16a..2a717607 100644 --- a/actions/patch.circuits.virtual_circuits.yaml +++ b/actions/patch.circuits.virtual_circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a virtual circuit object." enabled: true entry_point: run.py @@ -26,15 +26,15 @@ parameters: description: "Circuit ID" provider_network: required: false - type: object + type: integer description: "Provider network" provider_account: required: false - type: object + type: integer description: "Provider account" type: required: false - type: object + type: integer description: "Type" status: required: false @@ -47,12 +47,16 @@ parameters: * `decommissioned` - Decommissioned" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.core.data_sources.yaml b/actions/patch.core.data_sources.yaml index 0b1cb25e..60dc69bc 100644 --- a/actions/patch.core.data_sources.yaml +++ b/actions/patch.core.data_sources.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a data source object." enabled: true entry_point: run.py @@ -56,7 +56,11 @@ parameters: ignore_rules: required: false type: string - description: "Patterns (one per line) matching files to ignore when syncing" + description: "Patterns (one per line) matching files or paths to ignore when syncing" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.cable_bundles.yaml b/actions/patch.dcim.cable_bundles.yaml new file mode 100644 index 00000000..7fd1836f --- /dev/null +++ b/actions/patch.dcim.cable_bundles.yaml @@ -0,0 +1,51 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Patch a cable bundle object." +enabled: true +entry_point: run.py +name: patch.dcim.cable_bundles +parameters: + endpoint_uri: + default: "/dcim/cable-bundles/{{ id }}/" + immutable: true + type: string + http_verb: + default: patch + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" + id: + required: true + type: integer + description: "ID of the object to patch." +runner_type: python-script diff --git a/actions/patch.dcim.cables.yaml b/actions/patch.dcim.cables.yaml index 78a6ee2a..ce1375cc 100644 --- a/actions/patch.dcim.cables.yaml +++ b/actions/patch.dcim.cables.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a cable object." enabled: true entry_point: run.py @@ -31,22 +31,31 @@ parameters: * `cat7` - CAT7 * `cat7a` - CAT7a * `cat8` - CAT8 +* `mrj21-trunk` - MRJ21 Trunk * `dac-active` - Direct Attach Copper (Active) * `dac-passive` - Direct Attach Copper (Passive) -* `mrj21-trunk` - MRJ21 Trunk * `coaxial` - Coaxial +* `rg-6` - RG-6 +* `rg-8` - RG-8 +* `rg-11` - RG-11 +* `rg-59` - RG-59 +* `rg-62` - RG-62 +* `rg-213` - RG-213 +* `lmr-100` - LMR-100 +* `lmr-200` - LMR-200 +* `lmr-400` - LMR-400 * `mmf` - Multimode Fiber * `mmf-om1` - Multimode Fiber (OM1) * `mmf-om2` - Multimode Fiber (OM2) * `mmf-om3` - Multimode Fiber (OM3) * `mmf-om4` - Multimode Fiber (OM4) * `mmf-om5` - Multimode Fiber (OM5) -* `smf` - Singlemode Fiber -* `smf-os1` - Singlemode Fiber (OS1) -* `smf-os2` - Singlemode Fiber (OS2) +* `smf` - Single-mode Fiber +* `smf-os1` - Single-mode Fiber (OS1) +* `smf-os2` - Single-mode Fiber (OS2) * `aoc` - Active Optical Cabling (AOC) -* `usb` - USB -* `power` - Power" +* `power` - Power +* `usb` - USB" a_terminations: required: false type: array @@ -61,10 +70,42 @@ parameters: description: "* `connected` - Connected * `planned` - Planned * `decommissioning` - Decommissioning" + profile: + required: false + type: string + description: "* `single-1c1p` - 1C1P +* `single-1c2p` - 1C2P +* `single-1c4p` - 1C4P +* `single-1c6p` - 1C6P +* `single-1c8p` - 1C8P +* `single-1c12p` - 1C12P +* `single-1c16p` - 1C16P +* `trunk-2c1p` - 2C1P trunk +* `trunk-2c2p` - 2C2P trunk +* `trunk-2c4p` - 2C4P trunk +* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle) +* `trunk-2c6p` - 2C6P trunk +* `trunk-2c8p` - 2C8P trunk +* `trunk-2c12p` - 2C12P trunk +* `trunk-4c1p` - 4C1P trunk +* `trunk-4c2p` - 4C2P trunk +* `trunk-4c4p` - 4C4P trunk +* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle) +* `trunk-4c6p` - 4C6P trunk +* `trunk-4c8p` - 4C8P trunk +* `trunk-8c4p` - 8C4P trunk +* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout +* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout +* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout +* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)" tenant: required: false - type: object + type: integer description: "Tenant" + bundle: + required: false + type: integer + description: "Bundle" label: required: false type: string @@ -90,6 +131,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.console_port_templates.yaml b/actions/patch.dcim.console_port_templates.yaml index c2eb1f83..d16cb6a5 100644 --- a/actions/patch.dcim.console_port_templates.yaml +++ b/actions/patch.dcim.console_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a console port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false diff --git a/actions/patch.dcim.console_ports.yaml b/actions/patch.dcim.console_ports.yaml index 8c5bf55e..40c3cea3 100644 --- a/actions/patch.dcim.console_ports.yaml +++ b/actions/patch.dcim.console_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a console port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -77,6 +77,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.console_server_port_templates.yaml b/actions/patch.dcim.console_server_port_templates.yaml index 390245f7..aabcb77e 100644 --- a/actions/patch.dcim.console_server_port_templates.yaml +++ b/actions/patch.dcim.console_server_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a console server port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false diff --git a/actions/patch.dcim.console_server_ports.yaml b/actions/patch.dcim.console_server_ports.yaml index b36279df..584564bf 100644 --- a/actions/patch.dcim.console_server_ports.yaml +++ b/actions/patch.dcim.console_server_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a console server port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -77,6 +77,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.device_bay_templates.yaml b/actions/patch.dcim.device_bay_templates.yaml index 0b1100d7..c6c28e75 100644 --- a/actions/patch.dcim.device_bay_templates.yaml +++ b/actions/patch.dcim.device_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a device bay template object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" name: required: false @@ -32,6 +32,10 @@ parameters: required: false type: string description: "Physical label" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string diff --git a/actions/patch.dcim.device_bays.yaml b/actions/patch.dcim.device_bays.yaml index 70729adb..ad5effed 100644 --- a/actions/patch.dcim.device_bays.yaml +++ b/actions/patch.dcim.device_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a device bay object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" name: required: false @@ -32,14 +32,22 @@ parameters: required: false type: string description: "Physical label" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string description: "Description" installed_device: required: false - type: object + type: integer description: "Installed device" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.device_roles.yaml b/actions/patch.dcim.device_roles.yaml index c47b8723..b644efd7 100644 --- a/actions/patch.dcim.device_roles.yaml +++ b/actions/patch.dcim.device_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a device role object." enabled: true entry_point: run.py @@ -38,7 +38,7 @@ parameters: description: "Virtual machines may be assigned to this role" config_template: required: false - type: object + type: integer description: "Config template" parent: required: false @@ -56,6 +56,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.device_types.yaml b/actions/patch.dcim.device_types.yaml index 0f761326..2e385709 100644 --- a/actions/patch.dcim.device_types.yaml +++ b/actions/patch.dcim.device_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a device type object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. manufacturer: required: false - type: object + type: integer description: "Manufacturer" default_platform: required: false - type: object + type: integer description: "Default platform" model: required: false @@ -92,6 +92,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.devices.yaml b/actions/patch.dcim.devices.yaml index b6f4273f..8233fd82 100644 --- a/actions/patch.dcim.devices.yaml +++ b/actions/patch.dcim.devices.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a device object." enabled: true entry_point: run.py @@ -26,19 +26,19 @@ parameters: description: "Name" device_type: required: false - type: object + type: integer description: "Device type" role: required: false - type: object + type: integer description: "Role" tenant: required: false - type: object + type: integer description: "Tenant" platform: required: false - type: object + type: integer description: "Platform" serial: required: false @@ -50,15 +50,15 @@ parameters: description: "A unique tag used to identify this device" site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" rack: required: false - type: object + type: integer description: "Rack" position: required: false @@ -101,23 +101,23 @@ parameters: * `mixed` - Mixed" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" oob_ip: required: false - type: object + type: integer description: "Oob ip" cluster: required: false - type: object + type: integer description: "Cluster" virtual_chassis: required: false - type: object + type: integer description: "Virtual chassis" vc_position: required: false @@ -131,13 +131,17 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" config_template: required: false - type: object + type: integer description: "Config template" local_context_data: required: false diff --git a/actions/patch.dcim.front_port_templates.yaml b/actions/patch.dcim.front_port_templates.yaml index ecd29725..39e8cf92 100644 --- a/actions/patch.dcim.front_port_templates.yaml +++ b/actions/patch.dcim.front_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a front port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -101,14 +101,14 @@ parameters: required: false type: string description: "Color" - rear_port: - required: false - type: object - description: "Rear port" - rear_port_position: + positions: required: false type: integer - description: "Rear port position" + description: "Positions" + rear_ports: + required: false + type: array + description: "Rear ports" description: required: false type: string diff --git a/actions/patch.dcim.front_ports.yaml b/actions/patch.dcim.front_ports.yaml index c1bb63a3..b8a3d590 100644 --- a/actions/patch.dcim.front_ports.yaml +++ b/actions/patch.dcim.front_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a front port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -101,14 +101,14 @@ parameters: required: false type: string description: "Color" - rear_port: + positions: required: false type: integer - description: "Rear port" - rear_port_position: + description: "Positions" + rear_ports: required: false - type: integer - description: "Mapped position on corresponding rear port" + type: array + description: "Rear ports" description: required: false type: string @@ -117,6 +117,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.interface_templates.yaml b/actions/patch.dcim.interface_templates.yaml index 988b18b0..b2c818c6 100644 --- a/actions/patch.dcim.interface_templates.yaml +++ b/actions/patch.dcim.interface_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a interface template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -42,50 +42,133 @@ parameters: description: "* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) -* `100base-fx` - 100BASE-FX (10/100ME FIBER) -* `100base-lfx` - 100BASE-LFX (10/100ME FIBER) +* `100base-fx` - 100BASE-FX (10/100ME) +* `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) -* `100base-t1` - 100BASE-T1 (10/100ME Single Pair) -* `1000base-t` - 1000BASE-T (1GE) -* `1000base-sx` - 1000BASE-SX (1GE) +* `100base-t1` - 100BASE-T1 (10/100ME) +* `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) +* `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) +* `1000base-cwdm` - 1000BASE-CWDM (1GE) +* `1000base-cx` - 1000BASE-CX (1GE DAC) +* `1000base-dwdm` - 1000BASE-DWDM (1GE) +* `1000base-ex` - 1000BASE-EX (1GE) +* `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) +* `1000base-lx10` - 1000BASE-LX10/LH (1GE) +* `1000base-sx` - 1000BASE-SX (1GE) +* `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) +* `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) +* `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) +* `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) +* `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) +* `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) +* `10gbase-er` - 10GBASE-ER (10GE) +* `10gbase-lr` - 10GBASE-LR (10GE) +* `10gbase-lrm` - 10GBASE-LRM (10GE) +* `10gbase-lx4` - 10GBASE-LX4 (10GE) +* `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) -* `10gbase-cx4` - 10GBASE-CX4 (10GE) +* `10gbase-zr` - 10GBASE-ZR (10GE) +* `25gbase-cr` - 25GBASE-CR (25GE DAC) +* `25gbase-er` - 25GBASE-ER (25GE) +* `25gbase-lr` - 25GBASE-LR (25GE) +* `25gbase-sr` - 25GBASE-SR (25GE) +* `25gbase-t` - 25GBASE-T (25GE) +* `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) +* `40gbase-er4` - 40GBASE-ER4 (40GE) +* `40gbase-fr4` - 40GBASE-FR4 (40GE) +* `40gbase-lr4` - 40GBASE-LR4 (40GE) +* `40gbase-sr4` - 40GBASE-SR4 (40GE) +* `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) +* `50gbase-cr` - 50GBASE-CR (50GE DAC) +* `50gbase-er` - 50GBASE-ER (50GE) +* `50gbase-fr` - 50GBASE-FR (50GE) +* `50gbase-lr` - 50GBASE-LR (50GE) +* `50gbase-sr` - 50GBASE-SR (50GE) +* `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) +* `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) +* `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) +* `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) +* `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) +* `100gbase-dr` - 100GBASE-DR (100GE) +* `100gbase-er4` - 100GBASE-ER4 (100GE) +* `100gbase-fr1` - 100GBASE-FR1 (100GE) +* `100gbase-lr1` - 100GBASE-LR1 (100GE) +* `100gbase-lr4` - 100GBASE-LR4 (100GE) +* `100gbase-sr1` - 100GBASE-SR1 (100GE) +* `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) +* `100gbase-sr2` - 100GBASE-SR2 (100GE) +* `100gbase-sr4` - 100GBASE-SR4 (100GE) +* `100gbase-sr10` - 100GBASE-SR10 (100GE) +* `100gbase-zr` - 100GBASE-ZR (100GE) +* `200gbase-cr2` - 200GBASE-CR2 (200GE) +* `200gbase-cr4` - 200GBASE-CR4 (200GE) +* `200gbase-dr4` - 200GBASE-DR4 (200GE) +* `200gbase-er4` - 200GBASE-ER4 (200GE) +* `200gbase-fr4` - 200GBASE-FR4 (200GE) +* `200gbase-lr4` - 200GBASE-LR4 (200GE) +* `200gbase-sr2` - 200GBASE-SR2 (200GE) +* `200gbase-sr4` - 200GBASE-SR4 (200GE) +* `200gbase-vr2` - 200GBASE-VR2 (200GE) +* `400gbase-cr4` - 400GBASE-CR4 (400GE) +* `400gbase-dr4` - 400GBASE-DR4 (400GE) +* `400gbase-er8` - 400GBASE-ER8 (400GE) +* `400gbase-fr4` - 400GBASE-FR4 (400GE) +* `400gbase-fr8` - 400GBASE-FR8 (400GE) +* `400gbase-lr4` - 400GBASE-LR4 (400GE) +* `400gbase-lr8` - 400GBASE-LR8 (400GE) +* `400gbase-sr4` - 400GBASE-SR4 (400GE) +* `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) +* `400gbase-sr8` - 400GBASE-SR8 (400GE) +* `400gbase-sr16` - 400GBASE-SR16 (400GE) +* `400gbase-vr4` - 400GBASE-VR4 (400GE) +* `400gbase-zr` - 400GBASE-ZR (400GE) +* `800gbase-cr8` - 800GBASE-CR8 (800GE) +* `800gbase-dr8` - 800GBASE-DR8 (800GE) +* `800gbase-sr8` - 800GBASE-SR8 (800GE) +* `800gbase-vr8` - 800GBASE-VR8 (800GE) +* `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) +* `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) +* `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) +* `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) -* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) +* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) -* `50gbase-x-sfp56` - SFP56 (50GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) +* `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) -* `200gbase-x-cfp2` - CFP2 (200GE) -* `400gbase-x-cfp2` - CFP2 (400GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) -* `100gbase-x-sfpdd` - SFP-DD (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) +* `100gbase-x-sfpdd` - SFP-DD (100GE) +* `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) -* `400gbase-x-osfp` - OSFP (400GE) -* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `400gbase-x-cdfp` - CDFP (400GE) +* `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) -* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `400gbase-x-osfp` - OSFP (400GE) +* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) +* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) +* `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) +* `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) @@ -97,14 +180,15 @@ parameters: * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) +* `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g -* `ieee802.11n` - IEEE 802.11n -* `ieee802.11ac` - IEEE 802.11ac -* `ieee802.11ad` - IEEE 802.11ad -* `ieee802.11ax` - IEEE 802.11ax -* `ieee802.11ay` - IEEE 802.11ay -* `ieee802.11be` - IEEE 802.11be +* `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) +* `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) +* `ieee802.11ad` - IEEE 802.11ad (WiGig) +* `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) +* `ieee802.11ay` - IEEE 802.11ay (WiGig) +* `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) diff --git a/actions/patch.dcim.interfaces.yaml b/actions/patch.dcim.interfaces.yaml index a630b5d2..b507e9e9 100644 --- a/actions/patch.dcim.interfaces.yaml +++ b/actions/patch.dcim.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a interface object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" vdcs: required: false @@ -30,7 +30,7 @@ parameters: description: "Vdcs" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -46,50 +46,133 @@ parameters: description: "* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) -* `100base-fx` - 100BASE-FX (10/100ME FIBER) -* `100base-lfx` - 100BASE-LFX (10/100ME FIBER) +* `100base-fx` - 100BASE-FX (10/100ME) +* `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) -* `100base-t1` - 100BASE-T1 (10/100ME Single Pair) -* `1000base-t` - 1000BASE-T (1GE) -* `1000base-sx` - 1000BASE-SX (1GE) +* `100base-t1` - 100BASE-T1 (10/100ME) +* `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) +* `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) +* `1000base-cwdm` - 1000BASE-CWDM (1GE) +* `1000base-cx` - 1000BASE-CX (1GE DAC) +* `1000base-dwdm` - 1000BASE-DWDM (1GE) +* `1000base-ex` - 1000BASE-EX (1GE) +* `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) +* `1000base-lx10` - 1000BASE-LX10/LH (1GE) +* `1000base-sx` - 1000BASE-SX (1GE) +* `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) +* `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) +* `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) +* `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) +* `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) +* `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) +* `10gbase-er` - 10GBASE-ER (10GE) +* `10gbase-lr` - 10GBASE-LR (10GE) +* `10gbase-lrm` - 10GBASE-LRM (10GE) +* `10gbase-lx4` - 10GBASE-LX4 (10GE) +* `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) -* `10gbase-cx4` - 10GBASE-CX4 (10GE) +* `10gbase-zr` - 10GBASE-ZR (10GE) +* `25gbase-cr` - 25GBASE-CR (25GE DAC) +* `25gbase-er` - 25GBASE-ER (25GE) +* `25gbase-lr` - 25GBASE-LR (25GE) +* `25gbase-sr` - 25GBASE-SR (25GE) +* `25gbase-t` - 25GBASE-T (25GE) +* `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) +* `40gbase-er4` - 40GBASE-ER4 (40GE) +* `40gbase-fr4` - 40GBASE-FR4 (40GE) +* `40gbase-lr4` - 40GBASE-LR4 (40GE) +* `40gbase-sr4` - 40GBASE-SR4 (40GE) +* `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) +* `50gbase-cr` - 50GBASE-CR (50GE DAC) +* `50gbase-er` - 50GBASE-ER (50GE) +* `50gbase-fr` - 50GBASE-FR (50GE) +* `50gbase-lr` - 50GBASE-LR (50GE) +* `50gbase-sr` - 50GBASE-SR (50GE) +* `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) +* `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) +* `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) +* `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) +* `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) +* `100gbase-dr` - 100GBASE-DR (100GE) +* `100gbase-er4` - 100GBASE-ER4 (100GE) +* `100gbase-fr1` - 100GBASE-FR1 (100GE) +* `100gbase-lr1` - 100GBASE-LR1 (100GE) +* `100gbase-lr4` - 100GBASE-LR4 (100GE) +* `100gbase-sr1` - 100GBASE-SR1 (100GE) +* `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) +* `100gbase-sr2` - 100GBASE-SR2 (100GE) +* `100gbase-sr4` - 100GBASE-SR4 (100GE) +* `100gbase-sr10` - 100GBASE-SR10 (100GE) +* `100gbase-zr` - 100GBASE-ZR (100GE) +* `200gbase-cr2` - 200GBASE-CR2 (200GE) +* `200gbase-cr4` - 200GBASE-CR4 (200GE) +* `200gbase-dr4` - 200GBASE-DR4 (200GE) +* `200gbase-er4` - 200GBASE-ER4 (200GE) +* `200gbase-fr4` - 200GBASE-FR4 (200GE) +* `200gbase-lr4` - 200GBASE-LR4 (200GE) +* `200gbase-sr2` - 200GBASE-SR2 (200GE) +* `200gbase-sr4` - 200GBASE-SR4 (200GE) +* `200gbase-vr2` - 200GBASE-VR2 (200GE) +* `400gbase-cr4` - 400GBASE-CR4 (400GE) +* `400gbase-dr4` - 400GBASE-DR4 (400GE) +* `400gbase-er8` - 400GBASE-ER8 (400GE) +* `400gbase-fr4` - 400GBASE-FR4 (400GE) +* `400gbase-fr8` - 400GBASE-FR8 (400GE) +* `400gbase-lr4` - 400GBASE-LR4 (400GE) +* `400gbase-lr8` - 400GBASE-LR8 (400GE) +* `400gbase-sr4` - 400GBASE-SR4 (400GE) +* `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) +* `400gbase-sr8` - 400GBASE-SR8 (400GE) +* `400gbase-sr16` - 400GBASE-SR16 (400GE) +* `400gbase-vr4` - 400GBASE-VR4 (400GE) +* `400gbase-zr` - 400GBASE-ZR (400GE) +* `800gbase-cr8` - 800GBASE-CR8 (800GE) +* `800gbase-dr8` - 800GBASE-DR8 (800GE) +* `800gbase-sr8` - 800GBASE-SR8 (800GE) +* `800gbase-vr8` - 800GBASE-VR8 (800GE) +* `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) +* `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) +* `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) +* `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) -* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) +* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) -* `50gbase-x-sfp56` - SFP56 (50GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) +* `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) -* `200gbase-x-cfp2` - CFP2 (200GE) -* `400gbase-x-cfp2` - CFP2 (400GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) -* `100gbase-x-sfpdd` - SFP-DD (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) +* `100gbase-x-sfpdd` - SFP-DD (100GE) +* `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) -* `400gbase-x-osfp` - OSFP (400GE) -* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `400gbase-x-cdfp` - CDFP (400GE) +* `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) -* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `400gbase-x-osfp` - OSFP (400GE) +* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) +* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) +* `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) +* `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) @@ -101,14 +184,15 @@ parameters: * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) +* `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g -* `ieee802.11n` - IEEE 802.11n -* `ieee802.11ac` - IEEE 802.11ac -* `ieee802.11ad` - IEEE 802.11ad -* `ieee802.11ax` - IEEE 802.11ax -* `ieee802.11ay` - IEEE 802.11ay -* `ieee802.11be` - IEEE 802.11be +* `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) +* `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) +* `ieee802.11ad` - IEEE 802.11ad (WiGig) +* `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) +* `ieee802.11ay` - IEEE 802.11ay (WiGig) +* `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) @@ -197,7 +281,7 @@ parameters: description: "Mtu" primary_mac_address: required: false - type: object + type: integer description: "Primary mac address" speed: required: false @@ -268,7 +352,7 @@ parameters: description: "Transmit power (dBm)" untagged_vlan: required: false - type: object + type: integer description: "Untagged vlan" tagged_vlans: required: false @@ -276,11 +360,11 @@ parameters: description: "Tagged vlans" qinq_svlan: required: false - type: object + type: integer description: "Qinq svlan" vlan_translation_policy: required: false - type: object + type: integer description: "Vlan translation policy" mark_connected: required: false @@ -292,8 +376,12 @@ parameters: description: "Wireless lans" vrf: required: false - type: object + type: integer description: "Vrf" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.inventory_item_roles.yaml b/actions/patch.dcim.inventory_item_roles.yaml index 5c84c843..355fda8c 100644 --- a/actions/patch.dcim.inventory_item_roles.yaml +++ b/actions/patch.dcim.inventory_item_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a inventory item role object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.dcim.inventory_item_templates.yaml b/actions/patch.dcim.inventory_item_templates.yaml index e30f2c46..886efa96 100644 --- a/actions/patch.dcim.inventory_item_templates.yaml +++ b/actions/patch.dcim.inventory_item_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a inventory item template object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" parent: required: false @@ -38,11 +38,11 @@ parameters: description: "Physical label" role: required: false - type: object + type: integer description: "Role" manufacturer: required: false - type: object + type: integer description: "Manufacturer" part_id: required: false diff --git a/actions/patch.dcim.inventory_items.yaml b/actions/patch.dcim.inventory_items.yaml index 739f2974..b9347fa1 100644 --- a/actions/patch.dcim.inventory_items.yaml +++ b/actions/patch.dcim.inventory_items.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a inventory item object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" parent: required: false @@ -47,11 +47,11 @@ parameters: * `decommissioning` - Decommissioning" role: required: false - type: object + type: integer description: "Role" manufacturer: required: false - type: object + type: integer description: "Manufacturer" part_id: required: false @@ -81,6 +81,10 @@ parameters: required: false type: integer description: "Component id" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.locations.yaml b/actions/patch.dcim.locations.yaml index 9577c32f..b63cd2c2 100644 --- a/actions/patch.dcim.locations.yaml +++ b/actions/patch.dcim.locations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a location object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Slug" site: required: false - type: object + type: integer description: "Site" parent: required: false @@ -46,7 +46,7 @@ parameters: * `retired` - Retired" tenant: required: false - type: object + type: integer description: "Tenant" facility: required: false @@ -64,6 +64,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.mac_addresses.yaml b/actions/patch.dcim.mac_addresses.yaml index 67405f89..5e30ecec 100644 --- a/actions/patch.dcim.mac_addresses.yaml +++ b/actions/patch.dcim.mac_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a MAC address object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.manufacturers.yaml b/actions/patch.dcim.manufacturers.yaml index 66a600cd..c349b92d 100644 --- a/actions/patch.dcim.manufacturers.yaml +++ b/actions/patch.dcim.manufacturers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a manufacturer object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.dcim.module_bay_templates.yaml b/actions/patch.dcim.module_bay_templates.yaml index c218e2d8..02064671 100644 --- a/actions/patch.dcim.module_bay_templates.yaml +++ b/actions/patch.dcim.module_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a module bay template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Identifier to reference when renaming installed components" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string diff --git a/actions/patch.dcim.module_bays.yaml b/actions/patch.dcim.module_bays.yaml index e1883f19..2c7b56b1 100644 --- a/actions/patch.dcim.module_bays.yaml +++ b/actions/patch.dcim.module_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a module bay object." enabled: true entry_point: run.py @@ -22,20 +22,16 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false type: string description: "Name" - installed_module: - required: false - type: object - description: "Installed module" label: required: false type: string @@ -44,10 +40,22 @@ parameters: required: false type: string description: "Identifier to reference when renaming installed components" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string description: "Description" + installed_module: + required: false + type: integer + description: "Installed module" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.module_type_profiles.yaml b/actions/patch.dcim.module_type_profiles.yaml index 3d24583a..2fc771e6 100644 --- a/actions/patch.dcim.module_type_profiles.yaml +++ b/actions/patch.dcim.module_type_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a module type profile object." enabled: true entry_point: run.py @@ -32,6 +32,10 @@ parameters: required: false type: object description: "Schema" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.module_types.yaml b/actions/patch.dcim.module_types.yaml index 70531f56..5d6531da 100644 --- a/actions/patch.dcim.module_types.yaml +++ b/actions/patch.dcim.module_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a module type object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. profile: required: false - type: object + type: integer description: "Profile" manufacturer: required: false - type: object + type: integer description: "Manufacturer" model: required: false @@ -64,6 +64,10 @@ parameters: required: false type: object description: "Attributes" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.modules.yaml b/actions/patch.dcim.modules.yaml index 2cc1e819..12bba64b 100644 --- a/actions/patch.dcim.modules.yaml +++ b/actions/patch.dcim.modules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a module object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module_bay: required: false @@ -30,7 +30,7 @@ parameters: description: "Module bay" module_type: required: false - type: object + type: integer description: "Module type" status: required: false @@ -53,6 +53,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -65,6 +69,14 @@ parameters: required: false type: object description: "Custom fields" + replicate_components: + required: false + type: boolean + description: "Automatically populate components associated with this module type (default: true)" + adopt_components: + required: false + type: boolean + description: "Adopt already existing components" id: required: true type: integer diff --git a/actions/patch.dcim.platforms.yaml b/actions/patch.dcim.platforms.yaml index 8d232b3c..98c16e40 100644 --- a/actions/patch.dcim.platforms.yaml +++ b/actions/patch.dcim.platforms.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a platform object." enabled: true entry_point: run.py @@ -20,6 +20,10 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + parent: + required: false + type: integer + description: "Parent" name: required: false type: string @@ -30,16 +34,24 @@ parameters: description: "Slug" manufacturer: required: false - type: object + type: integer description: "Manufacturer" config_template: required: false - type: object + type: integer description: "Config template" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.dcim.power_feeds.yaml b/actions/patch.dcim.power_feeds.yaml index 578360eb..36d408d5 100644 --- a/actions/patch.dcim.power_feeds.yaml +++ b/actions/patch.dcim.power_feeds.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a power feed object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. power_panel: required: false - type: object + type: integer description: "Power panel" rack: required: false - type: object + type: integer description: "Rack" name: required: false @@ -76,8 +76,12 @@ parameters: description: "Description" tenant: required: false - type: object + type: integer description: "Tenant" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.power_outlet_templates.yaml b/actions/patch.dcim.power_outlet_templates.yaml index 36ab58e7..1eeb4011 100644 --- a/actions/patch.dcim.power_outlet_templates.yaml +++ b/actions/patch.dcim.power_outlet_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a power outlet template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -43,6 +43,7 @@ parameters: * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 +* `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -125,6 +126,7 @@ parameters: * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 @@ -137,9 +139,13 @@ parameters: * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other" + color: + required: false + type: string + description: "Color" power_port: required: false - type: object + type: integer description: "Power port" feed_leg: required: false diff --git a/actions/patch.dcim.power_outlets.yaml b/actions/patch.dcim.power_outlets.yaml index 8bd268cd..53e862ea 100644 --- a/actions/patch.dcim.power_outlets.yaml +++ b/actions/patch.dcim.power_outlets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a power outlet object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -45,6 +45,7 @@ parameters: * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 +* `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -127,6 +128,7 @@ parameters: * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 @@ -151,7 +153,7 @@ parameters: description: "Color" power_port: required: false - type: object + type: integer description: "Power port" feed_leg: required: false @@ -169,6 +171,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.power_panels.yaml b/actions/patch.dcim.power_panels.yaml index 642fd782..62c86bc8 100644 --- a/actions/patch.dcim.power_panels.yaml +++ b/actions/patch.dcim.power_panels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a power panel object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.power_port_templates.yaml b/actions/patch.dcim.power_port_templates.yaml index 877ddfdc..0f8796d3 100644 --- a/actions/patch.dcim.power_port_templates.yaml +++ b/actions/patch.dcim.power_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a power port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -43,6 +43,7 @@ parameters: * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 +* `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -133,6 +134,7 @@ parameters: * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid diff --git a/actions/patch.dcim.power_ports.yaml b/actions/patch.dcim.power_ports.yaml index f6e41dc2..54479e78 100644 --- a/actions/patch.dcim.power_ports.yaml +++ b/actions/patch.dcim.power_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a power port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -45,6 +45,7 @@ parameters: * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 +* `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -135,6 +136,7 @@ parameters: * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid @@ -161,6 +163,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.rack_groups.yaml b/actions/patch.dcim.rack_groups.yaml new file mode 100644 index 00000000..b1079b6e --- /dev/null +++ b/actions/patch.dcim.rack_groups.yaml @@ -0,0 +1,55 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Patch a rack group object." +enabled: true +entry_point: run.py +name: patch.dcim.rack_groups +parameters: + endpoint_uri: + default: "/dcim/rack-groups/{{ id }}/" + immutable: true + type: string + http_verb: + default: patch + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + slug: + required: false + type: string + description: "Slug" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" + id: + required: true + type: integer + description: "ID of the object to patch." +runner_type: python-script diff --git a/actions/patch.dcim.rack_reservations.yaml b/actions/patch.dcim.rack_reservations.yaml index 5fcfd0a2..b2f50aee 100644 --- a/actions/patch.dcim.rack_reservations.yaml +++ b/actions/patch.dcim.rack_reservations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a rack reservation object." enabled: true entry_point: run.py @@ -22,24 +22,34 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. rack: required: false - type: object + type: integer description: "Rack" units: required: false type: array description: "Units" + status: + required: false + type: string + description: "* `pending` - Pending +* `active` - Active +* `stale` - Stale" user: required: false - type: object + type: integer description: "User" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.rack_roles.yaml b/actions/patch.dcim.rack_roles.yaml index 3de20325..406a8a58 100644 --- a/actions/patch.dcim.rack_roles.yaml +++ b/actions/patch.dcim.rack_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a rack role object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.dcim.rack_types.yaml b/actions/patch.dcim.rack_types.yaml index 5d69ba30..8fa3b2ff 100644 --- a/actions/patch.dcim.rack_types.yaml +++ b/actions/patch.dcim.rack_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a rack type object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. manufacturer: required: false - type: object + type: integer description: "Manufacturer" model: required: false @@ -103,6 +103,10 @@ parameters: required: false type: integer description: "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails." + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.racks.yaml b/actions/patch.dcim.racks.yaml index 5ba870c2..8d69b675 100644 --- a/actions/patch.dcim.racks.yaml +++ b/actions/patch.dcim.racks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a rack object." enabled: true entry_point: run.py @@ -30,15 +30,19 @@ parameters: description: "Facility id" site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" + group: + required: false + type: integer + description: "Group" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -50,7 +54,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" serial: required: false @@ -62,7 +66,7 @@ parameters: description: "A unique tag used to identify this rack" rack_type: required: false - type: object + type: integer description: "Rack type" form_factor: required: false @@ -140,6 +144,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.rear_port_templates.yaml b/actions/patch.dcim.rear_port_templates.yaml index 4590fd32..789cd255 100644 --- a/actions/patch.dcim.rear_port_templates.yaml +++ b/actions/patch.dcim.rear_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a rear port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -105,6 +105,10 @@ parameters: required: false type: integer description: "Positions" + front_ports: + required: false + type: array + description: "Front ports" description: required: false type: string diff --git a/actions/patch.dcim.rear_ports.yaml b/actions/patch.dcim.rear_ports.yaml index c3dfbbc3..0dd605e9 100644 --- a/actions/patch.dcim.rear_ports.yaml +++ b/actions/patch.dcim.rear_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a rear port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -104,7 +104,11 @@ parameters: positions: required: false type: integer - description: "Number of front ports which may be mapped" + description: "Positions" + front_ports: + required: false + type: array + description: "Front ports" description: required: false type: string @@ -113,6 +117,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.dcim.regions.yaml b/actions/patch.dcim.regions.yaml index 515fe130..5fde78e1 100644 --- a/actions/patch.dcim.regions.yaml +++ b/actions/patch.dcim.regions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a region object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.site_groups.yaml b/actions/patch.dcim.site_groups.yaml index 26191c1b..cdeeb578 100644 --- a/actions/patch.dcim.site_groups.yaml +++ b/actions/patch.dcim.site_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a site group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.sites.yaml b/actions/patch.dcim.sites.yaml index eb48eb49..c86cf534 100644 --- a/actions/patch.dcim.sites.yaml +++ b/actions/patch.dcim.sites.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a site object." enabled: true entry_point: run.py @@ -38,15 +38,15 @@ parameters: * `retired` - Retired" region: required: false - type: object + type: integer description: "Region" group: required: false - type: object + type: integer description: "Group" tenant: required: false - type: object + type: integer description: "Tenant" facility: required: false @@ -76,6 +76,10 @@ parameters: required: false type: integer description: "GPS coordinate in decimal format (xx.yyyyyy)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.virtual_chassis.yaml b/actions/patch.dcim.virtual_chassis.yaml index 8ea0b0e6..cbae4f54 100644 --- a/actions/patch.dcim.virtual_chassis.yaml +++ b/actions/patch.dcim.virtual_chassis.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a virtual chassis object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.dcim.virtual_device_contexts.yaml b/actions/patch.dcim.virtual_device_contexts.yaml index f6f890fc..f3e42ecf 100644 --- a/actions/patch.dcim.virtual_device_contexts.yaml +++ b/actions/patch.dcim.virtual_device_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a virtual device context object." enabled: true entry_point: run.py @@ -26,7 +26,7 @@ parameters: description: "Name" device: required: false - type: object + type: integer description: "Device" identifier: required: false @@ -34,15 +34,15 @@ parameters: description: "Identifier" tenant: required: false - type: object + type: integer description: "Tenant" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" status: required: false @@ -54,6 +54,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.extras.bookmarks.yaml b/actions/patch.extras.bookmarks.yaml index c1a3b53a..d5a1b923 100644 --- a/actions/patch.extras.bookmarks.yaml +++ b/actions/patch.extras.bookmarks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a bookmark object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" id: required: true diff --git a/actions/patch.extras.config_context_profiles.yaml b/actions/patch.extras.config_context_profiles.yaml new file mode 100644 index 00000000..dc4770b0 --- /dev/null +++ b/actions/patch.extras.config_context_profiles.yaml @@ -0,0 +1,55 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Patch a config context profile object." +enabled: true +entry_point: run.py +name: patch.extras.config_context_profiles +parameters: + endpoint_uri: + default: "/extras/config-context-profiles/{{ id }}/" + immutable: true + type: string + http_verb: + default: patch + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + schema: + required: false + type: object + description: "A JSON schema specifying the structure of the context data for this profile" + tags: + required: false + type: array + description: "Array of tag strings" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + data_source: + required: false + type: integer + description: "Data source" + id: + required: true + type: integer + description: "ID of the object to patch." +runner_type: python-script diff --git a/actions/patch.extras.config_contexts.yaml b/actions/patch.extras.config_contexts.yaml index 57edeaba..4341e413 100644 --- a/actions/patch.extras.config_contexts.yaml +++ b/actions/patch.extras.config_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a config context object." enabled: true entry_point: run.py @@ -28,6 +28,10 @@ parameters: required: false type: integer description: "Weight" + profile: + required: false + type: integer + description: "Profile" description: required: false type: string @@ -84,13 +88,17 @@ parameters: required: false type: array description: "Tenants" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array description: "Array of tag strings" data_source: required: false - type: object + type: integer description: "Data source" data: required: false diff --git a/actions/patch.extras.config_templates.yaml b/actions/patch.extras.config_templates.yaml index bcb433bb..ccb5c559 100644 --- a/actions/patch.extras.config_templates.yaml +++ b/actions/patch.extras.config_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a config template object." enabled: true entry_point: run.py @@ -52,10 +52,22 @@ parameters: required: false type: boolean description: "Download file as attachment" + debug: + required: false + type: boolean + description: "Enable verbose error output when rendering this template. Not recommended for production use." data_source: required: false - type: object + type: integer description: "Data source" + auto_sync_enabled: + required: false + type: boolean + description: "Enable automatic synchronization of data when the data file is updated" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.extras.custom_field_choice_sets.yaml b/actions/patch.extras.custom_field_choice_sets.yaml index 2c2e0699..a1b7f737 100644 --- a/actions/patch.extras.custom_field_choice_sets.yaml +++ b/actions/patch.extras.custom_field_choice_sets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a custom field choice set object." enabled: true entry_point: run.py @@ -40,10 +40,18 @@ parameters: required: false type: array description: "Extra choices" + choice_colors: + required: false + type: object + description: "Choice colors" order_alphabetically: required: false type: boolean description: "Choices are automatically ordered alphabetically" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/patch.extras.custom_fields.yaml b/actions/patch.extras.custom_fields.yaml index 8953aace..acaa1505 100644 --- a/actions/patch.extras.custom_fields.yaml +++ b/actions/patch.extras.custom_fields.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a custom field object." enabled: true entry_point: run.py @@ -126,10 +126,18 @@ parameters: required: false type: string description: "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, <code>^[A-Z]{3}$</code> will limit values to exactly three uppercase letters." - choice_set: + validation_schema: required: false type: object + description: "A JSON schema definition for validating the custom field value" + choice_set: + required: false + type: integer description: "Choice set" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.extras.custom_links.yaml b/actions/patch.extras.custom_links.yaml index c0bf1299..bd2c6481 100644 --- a/actions/patch.extras.custom_links.yaml +++ b/actions/patch.extras.custom_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a custom link object." enabled: true entry_point: run.py @@ -72,6 +72,10 @@ parameters: required: false type: boolean description: "Force link to open in a new window" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/patch.extras.dashboard.yaml b/actions/patch.extras.dashboard.yaml index 23dbdd3e..dfae8364 100644 --- a/actions/patch.extras.dashboard.yaml +++ b/actions/patch.extras.dashboard.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a list of dashboard objects." enabled: true entry_point: run.py diff --git a/actions/patch.extras.event_rules.yaml b/actions/patch.extras.event_rules.yaml index 9f3cc697..b962bc4a 100644 --- a/actions/patch.extras.event_rules.yaml +++ b/actions/patch.extras.event_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a event rule object." enabled: true entry_point: run.py @@ -62,6 +62,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.extras.export_templates.yaml b/actions/patch.extras.export_templates.yaml index 139eedc9..ae380e68 100644 --- a/actions/patch.extras.export_templates.yaml +++ b/actions/patch.extras.export_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a export template object." enabled: true entry_point: run.py @@ -58,8 +58,12 @@ parameters: description: "Download file as attachment" data_source: required: false - type: object + type: integer description: "Data source" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/patch.extras.image_attachments.yaml b/actions/patch.extras.image_attachments.yaml index c969576d..c0548658 100644 --- a/actions/patch.extras.image_attachments.yaml +++ b/actions/patch.extras.image_attachments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a image attachment object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Image" + description: + required: false + type: string + description: "Description" id: required: true type: integer diff --git a/actions/patch.extras.journal_entries.yaml b/actions/patch.extras.journal_entries.yaml index af29651e..0d69ebf3 100644 --- a/actions/patch.extras.journal_entries.yaml +++ b/actions/patch.extras.journal_entries.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a journal entry object." enabled: true entry_point: run.py diff --git a/actions/patch.extras.notification_groups.yaml b/actions/patch.extras.notification_groups.yaml index 85454639..1908d45d 100644 --- a/actions/patch.extras.notification_groups.yaml +++ b/actions/patch.extras.notification_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a notification group object." enabled: true entry_point: run.py diff --git a/actions/patch.extras.notifications.yaml b/actions/patch.extras.notifications.yaml index decf98f2..f33381c1 100644 --- a/actions/patch.extras.notifications.yaml +++ b/actions/patch.extras.notifications.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a notification object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" read: required: false diff --git a/actions/patch.extras.saved_filters.yaml b/actions/patch.extras.saved_filters.yaml index b51adbaa..f386125a 100644 --- a/actions/patch.extras.saved_filters.yaml +++ b/actions/patch.extras.saved_filters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a saved filter object." enabled: true entry_point: run.py @@ -56,6 +56,10 @@ parameters: required: false type: object description: "Parameters" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/patch.extras.scripts.yaml b/actions/patch.extras.scripts.yaml index 817ef13a..11c4799b 100644 --- a/actions/patch.extras.scripts.yaml +++ b/actions/patch.extras.scripts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a script object." enabled: true entry_point: run.py @@ -36,6 +36,12 @@ parameters: required: false type: integer description: "Interval" + notifications: + required: false + type: string + description: "* `always` - Always +* `on_failure` - On failure +* `never` - Never" id: required: true type: integer diff --git a/actions/patch.extras.subscriptions.yaml b/actions/patch.extras.subscriptions.yaml index f6413562..f97e7ee5 100644 --- a/actions/patch.extras.subscriptions.yaml +++ b/actions/patch.extras.subscriptions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a subscription object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" id: required: true diff --git a/actions/patch.extras.table_configs.yaml b/actions/patch.extras.table_configs.yaml index cd2350bb..ec35bf20 100644 --- a/actions/patch.extras.table_configs.yaml +++ b/actions/patch.extras.table_configs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a table config object." enabled: true entry_point: run.py diff --git a/actions/patch.extras.tags.yaml b/actions/patch.extras.tags.yaml index f78f7369..72374487 100644 --- a/actions/patch.extras.tags.yaml +++ b/actions/patch.extras.tags.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a tag object." enabled: true entry_point: run.py diff --git a/actions/patch.extras.webhooks.yaml b/actions/patch.extras.webhooks.yaml index e7b9185e..52d7bb70 100644 --- a/actions/patch.extras.webhooks.yaml +++ b/actions/patch.extras.webhooks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a webhook object." enabled: true entry_point: run.py @@ -68,6 +68,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.ipam.aggregates.yaml b/actions/patch.ipam.aggregates.yaml index 0565ddd8..9a0c8e01 100644 --- a/actions/patch.ipam.aggregates.yaml +++ b/actions/patch.ipam.aggregates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a aggregate object." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Prefix" rir: required: false - type: object + type: integer description: "Rir" tenant: required: false - type: object + type: integer description: "Tenant" date_added: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.asn_ranges.yaml b/actions/patch.ipam.asn_ranges.yaml index 38343dcf..1df5e703 100644 --- a/actions/patch.ipam.asn_ranges.yaml +++ b/actions/patch.ipam.asn_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a ASN range object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Slug" rir: required: false - type: object + type: integer description: "Rir" start: required: false @@ -42,12 +42,20 @@ parameters: description: "End" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.ipam.asns.yaml b/actions/patch.ipam.asns.yaml index 77d09870..820e55b0 100644 --- a/actions/patch.ipam.asns.yaml +++ b/actions/patch.ipam.asns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a ASN object." enabled: true entry_point: run.py @@ -26,16 +26,24 @@ parameters: description: "16- or 32-bit autonomous system number" rir: required: false - type: object + type: integer description: "Rir" + role: + required: false + type: integer + description: "Role" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -48,6 +56,10 @@ parameters: required: false type: object description: "Custom fields" + sites: + required: false + type: array + description: "Sites" id: required: true type: integer diff --git a/actions/patch.ipam.fhrp_group_assignments.yaml b/actions/patch.ipam.fhrp_group_assignments.yaml index a96666b5..0465cc8f 100644 --- a/actions/patch.ipam.fhrp_group_assignments.yaml +++ b/actions/patch.ipam.fhrp_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a FHRP group assignment object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. group: required: false - type: object + type: integer description: "Group" interface_type: required: false diff --git a/actions/patch.ipam.fhrp_groups.yaml b/actions/patch.ipam.fhrp_groups.yaml index 7f19c425..2bf53555 100644 --- a/actions/patch.ipam.fhrp_groups.yaml +++ b/actions/patch.ipam.fhrp_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a FHRP group object." enabled: true entry_point: run.py @@ -50,6 +50,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.ip_addresses.yaml b/actions/patch.ipam.ip_addresses.yaml index 01ea6db0..663922e5 100644 --- a/actions/patch.ipam.ip_addresses.yaml +++ b/actions/patch.ipam.ip_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a IP address object." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Address" vrf: required: false - type: object + type: integer description: "Vrf" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -75,6 +75,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.ip_ranges.yaml b/actions/patch.ipam.ip_ranges.yaml index b28cfc11..e25df0e6 100644 --- a/actions/patch.ipam.ip_ranges.yaml +++ b/actions/patch.ipam.ip_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a IP range object." enabled: true entry_point: run.py @@ -30,11 +30,11 @@ parameters: description: "End address" vrf: required: false - type: object + type: integer description: "Vrf" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -46,12 +46,16 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -71,7 +75,7 @@ parameters: mark_utilized: required: false type: boolean - description: "Report space as 100% utilized" + description: "Report space as fully utilized" id: required: true type: integer diff --git a/actions/patch.ipam.prefixes.yaml b/actions/patch.ipam.prefixes.yaml index 2fe21374..54f96251 100644 --- a/actions/patch.ipam.prefixes.yaml +++ b/actions/patch.ipam.prefixes.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a prefix object." enabled: true entry_point: run.py @@ -26,7 +26,7 @@ parameters: description: "Prefix" vrf: required: false - type: object + type: integer description: "Vrf" scope_type: required: false @@ -38,11 +38,11 @@ parameters: description: "Scope id" tenant: required: false - type: object + type: integer description: "Tenant" vlan: required: false - type: object + type: integer description: "Vlan" status: required: false @@ -55,7 +55,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" is_pool: required: false @@ -69,6 +69,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.rirs.yaml b/actions/patch.ipam.rirs.yaml index 2d603534..2a599693 100644 --- a/actions/patch.ipam.rirs.yaml +++ b/actions/patch.ipam.rirs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a RIR object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.ipam.roles.yaml b/actions/patch.ipam.roles.yaml index d5e4b021..e2f4c071 100644 --- a/actions/patch.ipam.roles.yaml +++ b/actions/patch.ipam.roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a role object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.ipam.route_targets.yaml b/actions/patch.ipam.route_targets.yaml index 969d0bfd..9ab7699d 100644 --- a/actions/patch.ipam.route_targets.yaml +++ b/actions/patch.ipam.route_targets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a route target object." enabled: true entry_point: run.py @@ -26,12 +26,16 @@ parameters: description: "Route target value (formatted in accordance with RFC 4360)" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.service_templates.yaml b/actions/patch.ipam.service_templates.yaml index 568cc632..dd0b4942 100644 --- a/actions/patch.ipam.service_templates.yaml +++ b/actions/patch.ipam.service_templates.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Patch a service template object." +# NetBox API version: 4.6 +description: "Patch a application service template object." enabled: true entry_point: run.py name: patch.ipam.service_templates @@ -38,6 +38,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.services.yaml b/actions/patch.ipam.services.yaml index e3728d94..b39d5099 100644 --- a/actions/patch.ipam.services.yaml +++ b/actions/patch.ipam.services.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Patch a service object." +# NetBox API version: 4.6 +description: "Patch a application service object." enabled: true entry_point: run.py name: patch.ipam.services @@ -50,6 +50,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.vlan_groups.yaml b/actions/patch.ipam.vlan_groups.yaml index fa54ed7e..3768e334 100644 --- a/actions/patch.ipam.vlan_groups.yaml +++ b/actions/patch.ipam.vlan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a VLAN group object." enabled: true entry_point: run.py @@ -42,12 +42,20 @@ parameters: description: "Vid ranges" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.ipam.vlan_translation_policies.yaml b/actions/patch.ipam.vlan_translation_policies.yaml index d0a48eca..ddbe0d64 100644 --- a/actions/patch.ipam.vlan_translation_policies.yaml +++ b/actions/patch.ipam.vlan_translation_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a VLAN translation policy object." enabled: true entry_point: run.py @@ -28,6 +28,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" id: required: true type: integer diff --git a/actions/patch.ipam.vlan_translation_rules.yaml b/actions/patch.ipam.vlan_translation_rules.yaml index a8a933bf..219d4776 100644 --- a/actions/patch.ipam.vlan_translation_rules.yaml +++ b/actions/patch.ipam.vlan_translation_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a VLAN translation rule object." enabled: true entry_point: run.py diff --git a/actions/patch.ipam.vlans.yaml b/actions/patch.ipam.vlans.yaml index 521fb252..a3581195 100644 --- a/actions/patch.ipam.vlans.yaml +++ b/actions/patch.ipam.vlans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a VLAN object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. site: required: false - type: object + type: integer description: "Site" group: required: false - type: object + type: integer description: "Group" vid: required: false @@ -38,7 +38,7 @@ parameters: description: "Name" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -50,7 +50,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" description: required: false @@ -64,6 +64,10 @@ parameters: required: false type: integer description: "Qinq svlan" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.ipam.vrfs.yaml b/actions/patch.ipam.vrfs.yaml index 3007ef6d..b502236a 100644 --- a/actions/patch.ipam.vrfs.yaml +++ b/actions/patch.ipam.vrfs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a VRF object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Route distinguisher" tenant: required: false - type: object + type: integer description: "Tenant" enforce_unique: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.tenancy.contact_assignments.yaml b/actions/patch.tenancy.contact_assignments.yaml index c546342b..ee02340a 100644 --- a/actions/patch.tenancy.contact_assignments.yaml +++ b/actions/patch.tenancy.contact_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a contact assignment object." enabled: true entry_point: run.py @@ -30,11 +30,11 @@ parameters: description: "Object id" contact: required: false - type: object + type: integer description: "Contact" role: required: false - type: object + type: integer description: "Role" priority: required: false diff --git a/actions/patch.tenancy.contact_groups.yaml b/actions/patch.tenancy.contact_groups.yaml index 342b2384..1307e4cc 100644 --- a/actions/patch.tenancy.contact_groups.yaml +++ b/actions/patch.tenancy.contact_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a contact group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.tenancy.contact_roles.yaml b/actions/patch.tenancy.contact_roles.yaml index 0fc900b2..e975410b 100644 --- a/actions/patch.tenancy.contact_roles.yaml +++ b/actions/patch.tenancy.contact_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a contact role object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.tenancy.contacts.yaml b/actions/patch.tenancy.contacts.yaml index 52fe90e9..a659c07b 100644 --- a/actions/patch.tenancy.contacts.yaml +++ b/actions/patch.tenancy.contacts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a contact object." enabled: true entry_point: run.py @@ -52,6 +52,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.tenancy.tenant_groups.yaml b/actions/patch.tenancy.tenant_groups.yaml index cda00b46..d7aa7c27 100644 --- a/actions/patch.tenancy.tenant_groups.yaml +++ b/actions/patch.tenancy.tenant_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a tenant group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.tenancy.tenants.yaml b/actions/patch.tenancy.tenants.yaml index 5f705652..f2ae30d0 100644 --- a/actions/patch.tenancy.tenants.yaml +++ b/actions/patch.tenancy.tenants.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a tenant object." enabled: true entry_point: run.py @@ -30,12 +30,16 @@ parameters: description: "Slug" group: required: false - type: object + type: integer description: "Group" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.users.groups.yaml b/actions/patch.users.groups.yaml index 435167fc..a007689c 100644 --- a/actions/patch.users.groups.yaml +++ b/actions/patch.users.groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a group object." enabled: true entry_point: run.py diff --git a/actions/patch.users.owner_groups.yaml b/actions/patch.users.owner_groups.yaml new file mode 100644 index 00000000..22d77b1c --- /dev/null +++ b/actions/patch.users.owner_groups.yaml @@ -0,0 +1,35 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Patch a owner group object." +enabled: true +entry_point: run.py +name: patch.users.owner_groups +parameters: + endpoint_uri: + default: "/users/owner-groups/{{ id }}/" + immutable: true + type: string + http_verb: + default: patch + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + id: + required: true + type: integer + description: "ID of the object to patch." +runner_type: python-script diff --git a/actions/patch.dcim.cable_terminations.yaml b/actions/patch.users.owners.yaml similarity index 64% rename from actions/patch.dcim.cable_terminations.yaml rename to actions/patch.users.owners.yaml index b320f11b..3962ff28 100644 --- a/actions/patch.dcim.cable_terminations.yaml +++ b/actions/patch.users.owners.yaml @@ -1,12 +1,12 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Patch a cable termination object." +# NetBox API version: 4.6 +description: "Patch a owner object." enabled: true entry_point: run.py -name: patch.dcim.cable_terminations +name: patch.users.owners parameters: endpoint_uri: - default: "/dcim/cable-terminations/{{ id }}/" + default: "/users/owners/{{ id }}/" immutable: true type: string http_verb: @@ -20,22 +20,26 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. - cable: + name: + required: false + type: string + description: "Name" + group: required: false type: integer - description: "Cable" - cable_end: + description: "Group" + description: required: false type: string - description: "End" - termination_type: + description: "Description" + user_groups: required: false - type: string - description: "Termination type" - termination_id: + type: array + description: "User groups" + users: required: false - type: integer - description: "Termination id" + type: array + description: "Users" id: required: true type: integer diff --git a/actions/patch.users.permissions.yaml b/actions/patch.users.permissions.yaml index de81daef..959dfd93 100644 --- a/actions/patch.users.permissions.yaml +++ b/actions/patch.users.permissions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a permission object." enabled: true entry_point: run.py diff --git a/actions/patch.users.tokens.yaml b/actions/patch.users.tokens.yaml index 0df019b8..e6235547 100644 --- a/actions/patch.users.tokens.yaml +++ b/actions/patch.users.tokens.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a token object." enabled: true entry_point: run.py @@ -20,10 +20,19 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + version: + required: false + type: integer + description: "* `1` - v1 +* `2` - v2" user: required: false - type: object + type: integer description: "User" + description: + required: false + type: string + description: "Description" expires: required: false type: string @@ -32,18 +41,22 @@ parameters: required: false type: string description: "Last used" - key: + enabled: required: false - type: string - description: "Key" + type: boolean + description: "Disable to temporarily revoke this token without deleting it." write_enabled: required: false type: boolean - description: "Permit create/update/delete operations using this key" - description: + description: "Permit create/update/delete operations using this token" + pepper_id: + required: false + type: integer + description: "ID of the cryptographic pepper used to hash the token (v2 only)" + token: required: false type: string - description: "Description" + description: "Token" id: required: true type: integer diff --git a/actions/patch.users.users.yaml b/actions/patch.users.users.yaml index db893dea..e4f2cb2f 100644 --- a/actions/patch.users.users.yaml +++ b/actions/patch.users.users.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a user object." enabled: true entry_point: run.py @@ -40,10 +40,6 @@ parameters: required: false type: string description: "Email address" - is_staff: - required: false - type: boolean - description: "Staff status" is_active: required: false type: boolean diff --git a/actions/patch.virtualization.cluster_groups.yaml b/actions/patch.virtualization.cluster_groups.yaml index 48c8e9de..a2713d4b 100644 --- a/actions/patch.virtualization.cluster_groups.yaml +++ b/actions/patch.virtualization.cluster_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a cluster group object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.virtualization.cluster_types.yaml b/actions/patch.virtualization.cluster_types.yaml index 02924030..b5701a78 100644 --- a/actions/patch.virtualization.cluster_types.yaml +++ b/actions/patch.virtualization.cluster_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a cluster type object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.virtualization.clusters.yaml b/actions/patch.virtualization.clusters.yaml index 929f4bde..8fe0dde9 100644 --- a/actions/patch.virtualization.clusters.yaml +++ b/actions/patch.virtualization.clusters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a cluster object." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Name" type: required: false - type: object + type: integer description: "Type" group: required: false - type: object + type: integer description: "Group" status: required: false @@ -42,7 +42,7 @@ parameters: * `offline` - Offline" tenant: required: false - type: object + type: integer description: "Tenant" scope_type: required: false @@ -56,6 +56,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.virtualization.interfaces.yaml b/actions/patch.virtualization.interfaces.yaml index 4f71c9dc..ca336e04 100644 --- a/actions/patch.virtualization.interfaces.yaml +++ b/actions/patch.virtualization.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a interface object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_machine: required: false - type: object + type: integer description: "Virtual machine" name: required: false @@ -46,7 +46,7 @@ parameters: description: "Mtu" primary_mac_address: required: false - type: object + type: integer description: "Primary mac address" description: required: false @@ -63,7 +63,7 @@ parameters: * `q-in-q` - Q-in-Q (802.1ad)" untagged_vlan: required: false - type: object + type: integer description: "Untagged vlan" tagged_vlans: required: false @@ -71,16 +71,20 @@ parameters: description: "Tagged vlans" qinq_svlan: required: false - type: object + type: integer description: "Qinq svlan" vlan_translation_policy: required: false - type: object + type: integer description: "Vlan translation policy" vrf: required: false - type: object + type: integer description: "Vrf" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.virtualization.virtual_disks.yaml b/actions/patch.virtualization.virtual_disks.yaml index c23b6aa6..8589a0c9 100644 --- a/actions/patch.virtualization.virtual_disks.yaml +++ b/actions/patch.virtualization.virtual_disks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a virtual disk object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_machine: required: false - type: object + type: integer description: "Virtual machine" name: required: false @@ -35,7 +35,11 @@ parameters: size: required: false type: integer - description: "Size (MB)" + description: "Size" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/patch.virtualization.virtual_machine_types.yaml b/actions/patch.virtualization.virtual_machine_types.yaml new file mode 100644 index 00000000..8fdcdb70 --- /dev/null +++ b/actions/patch.virtualization.virtual_machine_types.yaml @@ -0,0 +1,67 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Patch a virtual machine type object." +enabled: true +entry_point: run.py +name: patch.virtualization.virtual_machine_types +parameters: + endpoint_uri: + default: "/virtualization/virtual-machine-types/{{ id }}/" + immutable: true + type: string + http_verb: + default: patch + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + slug: + required: false + type: string + description: "Slug" + default_platform: + required: false + type: integer + description: "Default platform" + default_vcpus: + required: false + type: integer + description: "Default vcpus" + default_memory: + required: false + type: integer + description: "Default memory (MB)" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" + id: + required: true + type: integer + description: "ID of the object to patch." +runner_type: python-script diff --git a/actions/patch.virtualization.virtual_machines.yaml b/actions/patch.virtualization.virtual_machines.yaml index be678a76..d4923b96 100644 --- a/actions/patch.virtualization.virtual_machines.yaml +++ b/actions/patch.virtualization.virtual_machines.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a virtual machine object." enabled: true entry_point: run.py @@ -24,6 +24,14 @@ parameters: required: false type: string description: "Name" + virtual_machine_type: + required: false + type: integer + description: "Virtual machine type" + role: + required: false + type: integer + description: "Role" status: required: false type: string @@ -34,41 +42,35 @@ parameters: * `failed` - Failed * `decommissioning` - Decommissioning * `paused` - Paused" + start_on_boot: + required: false + type: string + description: "* `on` - On +* `off` - Off +* `laststate` - Last State" site: required: false - type: object + type: integer description: "Site" cluster: required: false - type: object + type: integer description: "Cluster" device: required: false - type: object + type: integer description: "Device" - serial: - required: false - type: string - description: "Serial number" - role: - required: false - type: object - description: "Role" - tenant: - required: false - type: object - description: "Tenant" platform: required: false - type: object + type: integer description: "Platform" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" vcpus: required: false @@ -77,31 +79,43 @@ parameters: memory: required: false type: integer - description: "Memory (MB)" + description: "Memory" disk: required: false type: integer - description: "Disk (MB)" + description: "Disk" description: required: false type: string description: "Description" + serial: + required: false + type: string + description: "Serial number" + tenant: + required: false + type: integer + description: "Tenant" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" - config_template: + tags: required: false - type: object - description: "Config template" + type: array + description: "Array of tag strings" local_context_data: required: false type: object description: "Local config context data takes precedence over source contexts in the final rendered config context" - tags: + config_template: required: false - type: array - description: "Array of tag strings" + type: integer + description: "Config template" custom_fields: required: false type: object diff --git a/actions/patch.vpn.ike_policies.yaml b/actions/patch.vpn.ike_policies.yaml index 2f61e374..4e0d2630 100644 --- a/actions/patch.vpn.ike_policies.yaml +++ b/actions/patch.vpn.ike_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a IKE policy object." enabled: true entry_point: run.py @@ -46,6 +46,10 @@ parameters: required: false type: string description: "Pre-shared key" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.vpn.ike_proposals.yaml b/actions/patch.vpn.ike_proposals.yaml index ae976e67..eb3384cd 100644 --- a/actions/patch.vpn.ike_proposals.yaml +++ b/actions/patch.vpn.ike_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a IKE proposal object." enabled: true entry_point: run.py @@ -87,6 +87,10 @@ parameters: required: false type: integer description: "Security association lifetime (in seconds)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.vpn.ipsec_policies.yaml b/actions/patch.vpn.ipsec_policies.yaml index 0a7925d2..09e47669 100644 --- a/actions/patch.vpn.ipsec_policies.yaml +++ b/actions/patch.vpn.ipsec_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a IPSec policy object." enabled: true entry_point: run.py @@ -61,6 +61,10 @@ parameters: * `32` - Group 32 * `33` - Group 33 * `34` - Group 34" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.vpn.ipsec_profiles.yaml b/actions/patch.vpn.ipsec_profiles.yaml index 0265d7ad..d830fe20 100644 --- a/actions/patch.vpn.ipsec_profiles.yaml +++ b/actions/patch.vpn.ipsec_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a IPSec profile object." enabled: true entry_point: run.py @@ -35,12 +35,16 @@ parameters: * `ah` - AH" ike_policy: required: false - type: object + type: integer description: "Ike policy" ipsec_policy: required: false - type: object + type: integer description: "Ipsec policy" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.vpn.ipsec_proposals.yaml b/actions/patch.vpn.ipsec_proposals.yaml index f2892cb1..bbe65a72 100644 --- a/actions/patch.vpn.ipsec_proposals.yaml +++ b/actions/patch.vpn.ipsec_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a IPSec proposal object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: integer description: "SA lifetime (KB)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.vpn.l2vpn_terminations.yaml b/actions/patch.vpn.l2vpn_terminations.yaml index 7e38124b..0944a8c1 100644 --- a/actions/patch.vpn.l2vpn_terminations.yaml +++ b/actions/patch.vpn.l2vpn_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a L2VPN termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. l2vpn: required: false - type: object + type: integer description: "L2vpn" assigned_object_type: required: false diff --git a/actions/patch.vpn.l2vpns.yaml b/actions/patch.vpn.l2vpns.yaml index 39b9e420..9d9a7690 100644 --- a/actions/patch.vpn.l2vpns.yaml +++ b/actions/patch.vpn.l2vpns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a L2VPN object." enabled: true entry_point: run.py @@ -67,13 +67,17 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" tenant: required: false - type: object + type: integer description: "Tenant" tags: required: false diff --git a/actions/patch.vpn.tunnel_groups.yaml b/actions/patch.vpn.tunnel_groups.yaml index 31c9a164..1d242cb2 100644 --- a/actions/patch.vpn.tunnel_groups.yaml +++ b/actions/patch.vpn.tunnel_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a tunnel group object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/patch.vpn.tunnel_terminations.yaml b/actions/patch.vpn.tunnel_terminations.yaml index 288d331a..6ea4704b 100644 --- a/actions/patch.vpn.tunnel_terminations.yaml +++ b/actions/patch.vpn.tunnel_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a tunnel termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. tunnel: required: false - type: object + type: integer description: "Tunnel" role: required: false @@ -40,7 +40,7 @@ parameters: description: "Termination id" outside_ip: required: false - type: object + type: integer description: "Outside ip" tags: required: false diff --git a/actions/patch.vpn.tunnels.yaml b/actions/patch.vpn.tunnels.yaml index b9cbf719..f2df0414 100644 --- a/actions/patch.vpn.tunnels.yaml +++ b/actions/patch.vpn.tunnels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a tunnel object." enabled: true entry_point: run.py @@ -32,7 +32,7 @@ parameters: * `disabled` - Disabled" group: required: false - type: object + type: integer description: "Group" encapsulation: required: false @@ -47,11 +47,11 @@ parameters: * `pptp` - PPTP" ipsec_profile: required: false - type: object + type: integer description: "Ipsec profile" tenant: required: false - type: object + type: integer description: "Tenant" tunnel_id: required: false @@ -61,6 +61,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.wireless.wireless_lan_groups.yaml b/actions/patch.wireless.wireless_lan_groups.yaml index b31f9842..5234fbee 100644 --- a/actions/patch.wireless.wireless_lan_groups.yaml +++ b/actions/patch.wireless.wireless_lan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a wireless LAN group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.wireless.wireless_lans.yaml b/actions/patch.wireless.wireless_lans.yaml index 74e9290a..51d2e097 100644 --- a/actions/patch.wireless.wireless_lans.yaml +++ b/actions/patch.wireless.wireless_lans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a wireless LAN object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Description" group: required: false - type: object + type: integer description: "Group" status: required: false @@ -41,7 +41,7 @@ parameters: * `deprecated` - Deprecated" vlan: required: false - type: object + type: integer description: "Vlan" scope_type: required: false @@ -53,7 +53,7 @@ parameters: description: "Scope id" tenant: required: false - type: object + type: integer description: "Tenant" auth_type: required: false @@ -67,6 +67,10 @@ parameters: required: false type: string description: "Pre-shared key" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/patch.wireless.wireless_links.yaml b/actions/patch.wireless.wireless_links.yaml index d0458aab..116cf316 100644 --- a/actions/patch.wireless.wireless_links.yaml +++ b/actions/patch.wireless.wireless_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Patch a wireless link object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. interface_a: required: false - type: object + type: integer description: "Interface a" interface_b: required: false - type: object + type: integer description: "Interface b" ssid: required: false @@ -40,7 +40,7 @@ parameters: * `decommissioning` - Decommissioning" tenant: required: false - type: object + type: integer description: "Tenant" auth_type: required: false @@ -69,6 +69,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.circuits.circuit_group_assignments.yaml b/actions/post.circuits.circuit_group_assignments.yaml index c2196349..9cfd8d44 100644 --- a/actions/post.circuits.circuit_group_assignments.yaml +++ b/actions/post.circuits.circuit_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of Circuit group assignment objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. group: required: false - type: object + type: integer description: "Group" member_type: required: false diff --git a/actions/post.circuits.circuit_groups.yaml b/actions/post.circuits.circuit_groups.yaml index b227a70a..22b4018a 100644 --- a/actions/post.circuits.circuit_groups.yaml +++ b/actions/post.circuits.circuit_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of circuit group objects." enabled: true entry_point: run.py @@ -34,8 +34,16 @@ parameters: description: "Description" tenant: required: false - type: object + type: integer description: "Tenant" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.circuits.circuit_terminations.yaml b/actions/post.circuits.circuit_terminations.yaml index 54718c66..0fc79750 100644 --- a/actions/post.circuits.circuit_terminations.yaml +++ b/actions/post.circuits.circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of circuit termination objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. circuit: required: false - type: object + type: integer description: "Circuit" term_side: required: false diff --git a/actions/post.circuits.circuit_types.yaml b/actions/post.circuits.circuit_types.yaml index aea9a818..44d2ce40 100644 --- a/actions/post.circuits.circuit_types.yaml +++ b/actions/post.circuits.circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of circuit type objects." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.circuits.circuits.yaml b/actions/post.circuits.circuits.yaml index 400bee60..2b11dd77 100644 --- a/actions/post.circuits.circuits.yaml +++ b/actions/post.circuits.circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of circuit objects." enabled: true entry_point: run.py @@ -26,15 +26,15 @@ parameters: description: "Circuit ID" provider: required: false - type: object + type: integer description: "Provider" provider_account: required: false - type: object + type: integer description: "Provider account" type: required: false - type: object + type: integer description: "Type" status: required: false @@ -47,7 +47,7 @@ parameters: * `decommissioned` - Decommissioned" tenant: required: false - type: object + type: integer description: "Tenant" install_date: required: false @@ -76,6 +76,10 @@ parameters: * `m` - Meters * `mi` - Miles * `ft` - Feet" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.circuits.provider_accounts.yaml b/actions/post.circuits.provider_accounts.yaml index 16839155..a76e7a5f 100644 --- a/actions/post.circuits.provider_accounts.yaml +++ b/actions/post.circuits.provider_accounts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of provider account objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. provider: required: false - type: object + type: integer description: "Provider" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.circuits.provider_networks.yaml b/actions/post.circuits.provider_networks.yaml index c52d6833..85da9964 100644 --- a/actions/post.circuits.provider_networks.yaml +++ b/actions/post.circuits.provider_networks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of provider network objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. provider: required: false - type: object + type: integer description: "Provider" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.circuits.providers.yaml b/actions/post.circuits.providers.yaml index 59ad77c2..99a3e8d1 100644 --- a/actions/post.circuits.providers.yaml +++ b/actions/post.circuits.providers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of provider objects." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.circuits.virtual_circuit_terminations.yaml b/actions/post.circuits.virtual_circuit_terminations.yaml index f1a451ad..022dfd68 100644 --- a/actions/post.circuits.virtual_circuit_terminations.yaml +++ b/actions/post.circuits.virtual_circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of virtual circuit termination objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_circuit: required: false - type: object + type: integer description: "Virtual circuit" role: required: false @@ -32,7 +32,7 @@ parameters: * `spoke` - Spoke" interface: required: false - type: object + type: integer description: "Interface" description: required: false diff --git a/actions/post.circuits.virtual_circuit_types.yaml b/actions/post.circuits.virtual_circuit_types.yaml index 22ec6eb2..771fd580 100644 --- a/actions/post.circuits.virtual_circuit_types.yaml +++ b/actions/post.circuits.virtual_circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of virtual circuit type objects." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.circuits.virtual_circuits.yaml b/actions/post.circuits.virtual_circuits.yaml index 3a96b7e6..f4262429 100644 --- a/actions/post.circuits.virtual_circuits.yaml +++ b/actions/post.circuits.virtual_circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of virtual circuit objects." enabled: true entry_point: run.py @@ -26,15 +26,15 @@ parameters: description: "Circuit ID" provider_network: required: false - type: object + type: integer description: "Provider network" provider_account: required: false - type: object + type: integer description: "Provider account" type: required: false - type: object + type: integer description: "Type" status: required: false @@ -47,12 +47,16 @@ parameters: * `decommissioned` - Decommissioned" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.core.data_sources.yaml b/actions/post.core.data_sources.yaml index 08aab609..7fe0a04a 100644 --- a/actions/post.core.data_sources.yaml +++ b/actions/post.core.data_sources.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of data source objects." enabled: true entry_point: run.py @@ -56,7 +56,11 @@ parameters: ignore_rules: required: false type: string - description: "Patterns (one per line) matching files to ignore when syncing" + description: "Patterns (one per line) matching files or paths to ignore when syncing" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.cable_bundles.yaml b/actions/post.dcim.cable_bundles.yaml new file mode 100644 index 00000000..1747fab5 --- /dev/null +++ b/actions/post.dcim.cable_bundles.yaml @@ -0,0 +1,47 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Post a list of cable bundle objects." +enabled: true +entry_point: run.py +name: post.dcim.cable_bundles +parameters: + endpoint_uri: + default: "/dcim/cable-bundles/" + immutable: true + type: string + http_verb: + default: post + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" +runner_type: python-script diff --git a/actions/post.dcim.cables.yaml b/actions/post.dcim.cables.yaml index 211bfe98..8993fc18 100644 --- a/actions/post.dcim.cables.yaml +++ b/actions/post.dcim.cables.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of cable objects." enabled: true entry_point: run.py @@ -31,22 +31,31 @@ parameters: * `cat7` - CAT7 * `cat7a` - CAT7a * `cat8` - CAT8 +* `mrj21-trunk` - MRJ21 Trunk * `dac-active` - Direct Attach Copper (Active) * `dac-passive` - Direct Attach Copper (Passive) -* `mrj21-trunk` - MRJ21 Trunk * `coaxial` - Coaxial +* `rg-6` - RG-6 +* `rg-8` - RG-8 +* `rg-11` - RG-11 +* `rg-59` - RG-59 +* `rg-62` - RG-62 +* `rg-213` - RG-213 +* `lmr-100` - LMR-100 +* `lmr-200` - LMR-200 +* `lmr-400` - LMR-400 * `mmf` - Multimode Fiber * `mmf-om1` - Multimode Fiber (OM1) * `mmf-om2` - Multimode Fiber (OM2) * `mmf-om3` - Multimode Fiber (OM3) * `mmf-om4` - Multimode Fiber (OM4) * `mmf-om5` - Multimode Fiber (OM5) -* `smf` - Singlemode Fiber -* `smf-os1` - Singlemode Fiber (OS1) -* `smf-os2` - Singlemode Fiber (OS2) +* `smf` - Single-mode Fiber +* `smf-os1` - Single-mode Fiber (OS1) +* `smf-os2` - Single-mode Fiber (OS2) * `aoc` - Active Optical Cabling (AOC) -* `usb` - USB -* `power` - Power" +* `power` - Power +* `usb` - USB" a_terminations: required: false type: array @@ -61,10 +70,42 @@ parameters: description: "* `connected` - Connected * `planned` - Planned * `decommissioning` - Decommissioning" + profile: + required: false + type: string + description: "* `single-1c1p` - 1C1P +* `single-1c2p` - 1C2P +* `single-1c4p` - 1C4P +* `single-1c6p` - 1C6P +* `single-1c8p` - 1C8P +* `single-1c12p` - 1C12P +* `single-1c16p` - 1C16P +* `trunk-2c1p` - 2C1P trunk +* `trunk-2c2p` - 2C2P trunk +* `trunk-2c4p` - 2C4P trunk +* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle) +* `trunk-2c6p` - 2C6P trunk +* `trunk-2c8p` - 2C8P trunk +* `trunk-2c12p` - 2C12P trunk +* `trunk-4c1p` - 4C1P trunk +* `trunk-4c2p` - 4C2P trunk +* `trunk-4c4p` - 4C4P trunk +* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle) +* `trunk-4c6p` - 4C6P trunk +* `trunk-4c8p` - 4C8P trunk +* `trunk-8c4p` - 8C4P trunk +* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout +* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout +* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout +* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)" tenant: required: false - type: object + type: integer description: "Tenant" + bundle: + required: false + type: integer + description: "Bundle" label: required: false type: string @@ -90,6 +131,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.console_port_templates.yaml b/actions/post.dcim.console_port_templates.yaml index 4e0a94eb..190326bf 100644 --- a/actions/post.dcim.console_port_templates.yaml +++ b/actions/post.dcim.console_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of console port template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false diff --git a/actions/post.dcim.console_ports.yaml b/actions/post.dcim.console_ports.yaml index f448b49b..b4c3a703 100644 --- a/actions/post.dcim.console_ports.yaml +++ b/actions/post.dcim.console_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of console port objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -77,6 +77,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.console_server_port_templates.yaml b/actions/post.dcim.console_server_port_templates.yaml index d2f343a6..f0766637 100644 --- a/actions/post.dcim.console_server_port_templates.yaml +++ b/actions/post.dcim.console_server_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of console server port template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false diff --git a/actions/post.dcim.console_server_ports.yaml b/actions/post.dcim.console_server_ports.yaml index 6b389302..82e249f4 100644 --- a/actions/post.dcim.console_server_ports.yaml +++ b/actions/post.dcim.console_server_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of console server port objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -77,6 +77,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.device_bay_templates.yaml b/actions/post.dcim.device_bay_templates.yaml index d8f56310..f16dace7 100644 --- a/actions/post.dcim.device_bay_templates.yaml +++ b/actions/post.dcim.device_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of device bay template objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" name: required: false @@ -32,6 +32,10 @@ parameters: required: false type: string description: "Physical label" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string diff --git a/actions/post.dcim.device_bays.yaml b/actions/post.dcim.device_bays.yaml index eff7ccd4..4c37543d 100644 --- a/actions/post.dcim.device_bays.yaml +++ b/actions/post.dcim.device_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of device bay objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" name: required: false @@ -32,14 +32,22 @@ parameters: required: false type: string description: "Physical label" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string description: "Description" installed_device: required: false - type: object + type: integer description: "Installed device" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.device_roles.yaml b/actions/post.dcim.device_roles.yaml index 0e960bf1..df8bd6e0 100644 --- a/actions/post.dcim.device_roles.yaml +++ b/actions/post.dcim.device_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of device role objects." enabled: true entry_point: run.py @@ -38,7 +38,7 @@ parameters: description: "Virtual machines may be assigned to this role" config_template: required: false - type: object + type: integer description: "Config template" parent: required: false @@ -56,6 +56,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.device_types.yaml b/actions/post.dcim.device_types.yaml index 66e0737b..bdfdc87d 100644 --- a/actions/post.dcim.device_types.yaml +++ b/actions/post.dcim.device_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of device type objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. manufacturer: required: false - type: object + type: integer description: "Manufacturer" default_platform: required: false - type: object + type: integer description: "Default platform" model: required: false @@ -92,6 +92,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.devices.yaml b/actions/post.dcim.devices.yaml index 28caf779..af2fce25 100644 --- a/actions/post.dcim.devices.yaml +++ b/actions/post.dcim.devices.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of device objects." enabled: true entry_point: run.py @@ -26,19 +26,19 @@ parameters: description: "Name" device_type: required: false - type: object + type: integer description: "Device type" role: required: false - type: object + type: integer description: "Role" tenant: required: false - type: object + type: integer description: "Tenant" platform: required: false - type: object + type: integer description: "Platform" serial: required: false @@ -50,15 +50,15 @@ parameters: description: "A unique tag used to identify this device" site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" rack: required: false - type: object + type: integer description: "Rack" position: required: false @@ -101,23 +101,23 @@ parameters: * `mixed` - Mixed" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" oob_ip: required: false - type: object + type: integer description: "Oob ip" cluster: required: false - type: object + type: integer description: "Cluster" virtual_chassis: required: false - type: object + type: integer description: "Virtual chassis" vc_position: required: false @@ -131,13 +131,17 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" config_template: required: false - type: object + type: integer description: "Config template" local_context_data: required: false diff --git a/actions/post.dcim.front_port_templates.yaml b/actions/post.dcim.front_port_templates.yaml index 00bc53bc..b4b45a5d 100644 --- a/actions/post.dcim.front_port_templates.yaml +++ b/actions/post.dcim.front_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of front port template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -101,14 +101,14 @@ parameters: required: false type: string description: "Color" - rear_port: - required: false - type: object - description: "Rear port" - rear_port_position: + positions: required: false type: integer - description: "Rear port position" + description: "Positions" + rear_ports: + required: false + type: array + description: "Rear ports" description: required: false type: string diff --git a/actions/post.dcim.front_ports.yaml b/actions/post.dcim.front_ports.yaml index a414aee9..c3c5390f 100644 --- a/actions/post.dcim.front_ports.yaml +++ b/actions/post.dcim.front_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of front port objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -101,14 +101,14 @@ parameters: required: false type: string description: "Color" - rear_port: + positions: required: false type: integer - description: "Rear port" - rear_port_position: + description: "Positions" + rear_ports: required: false - type: integer - description: "Mapped position on corresponding rear port" + type: array + description: "Rear ports" description: required: false type: string @@ -117,6 +117,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.interface_templates.yaml b/actions/post.dcim.interface_templates.yaml index a31f02be..8f8a2a03 100644 --- a/actions/post.dcim.interface_templates.yaml +++ b/actions/post.dcim.interface_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of interface template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -42,50 +42,133 @@ parameters: description: "* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) -* `100base-fx` - 100BASE-FX (10/100ME FIBER) -* `100base-lfx` - 100BASE-LFX (10/100ME FIBER) +* `100base-fx` - 100BASE-FX (10/100ME) +* `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) -* `100base-t1` - 100BASE-T1 (10/100ME Single Pair) -* `1000base-t` - 1000BASE-T (1GE) -* `1000base-sx` - 1000BASE-SX (1GE) +* `100base-t1` - 100BASE-T1 (10/100ME) +* `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) +* `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) +* `1000base-cwdm` - 1000BASE-CWDM (1GE) +* `1000base-cx` - 1000BASE-CX (1GE DAC) +* `1000base-dwdm` - 1000BASE-DWDM (1GE) +* `1000base-ex` - 1000BASE-EX (1GE) +* `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) +* `1000base-lx10` - 1000BASE-LX10/LH (1GE) +* `1000base-sx` - 1000BASE-SX (1GE) +* `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) +* `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) +* `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) +* `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) +* `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) +* `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) +* `10gbase-er` - 10GBASE-ER (10GE) +* `10gbase-lr` - 10GBASE-LR (10GE) +* `10gbase-lrm` - 10GBASE-LRM (10GE) +* `10gbase-lx4` - 10GBASE-LX4 (10GE) +* `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) -* `10gbase-cx4` - 10GBASE-CX4 (10GE) +* `10gbase-zr` - 10GBASE-ZR (10GE) +* `25gbase-cr` - 25GBASE-CR (25GE DAC) +* `25gbase-er` - 25GBASE-ER (25GE) +* `25gbase-lr` - 25GBASE-LR (25GE) +* `25gbase-sr` - 25GBASE-SR (25GE) +* `25gbase-t` - 25GBASE-T (25GE) +* `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) +* `40gbase-er4` - 40GBASE-ER4 (40GE) +* `40gbase-fr4` - 40GBASE-FR4 (40GE) +* `40gbase-lr4` - 40GBASE-LR4 (40GE) +* `40gbase-sr4` - 40GBASE-SR4 (40GE) +* `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) +* `50gbase-cr` - 50GBASE-CR (50GE DAC) +* `50gbase-er` - 50GBASE-ER (50GE) +* `50gbase-fr` - 50GBASE-FR (50GE) +* `50gbase-lr` - 50GBASE-LR (50GE) +* `50gbase-sr` - 50GBASE-SR (50GE) +* `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) +* `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) +* `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) +* `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) +* `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) +* `100gbase-dr` - 100GBASE-DR (100GE) +* `100gbase-er4` - 100GBASE-ER4 (100GE) +* `100gbase-fr1` - 100GBASE-FR1 (100GE) +* `100gbase-lr1` - 100GBASE-LR1 (100GE) +* `100gbase-lr4` - 100GBASE-LR4 (100GE) +* `100gbase-sr1` - 100GBASE-SR1 (100GE) +* `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) +* `100gbase-sr2` - 100GBASE-SR2 (100GE) +* `100gbase-sr4` - 100GBASE-SR4 (100GE) +* `100gbase-sr10` - 100GBASE-SR10 (100GE) +* `100gbase-zr` - 100GBASE-ZR (100GE) +* `200gbase-cr2` - 200GBASE-CR2 (200GE) +* `200gbase-cr4` - 200GBASE-CR4 (200GE) +* `200gbase-dr4` - 200GBASE-DR4 (200GE) +* `200gbase-er4` - 200GBASE-ER4 (200GE) +* `200gbase-fr4` - 200GBASE-FR4 (200GE) +* `200gbase-lr4` - 200GBASE-LR4 (200GE) +* `200gbase-sr2` - 200GBASE-SR2 (200GE) +* `200gbase-sr4` - 200GBASE-SR4 (200GE) +* `200gbase-vr2` - 200GBASE-VR2 (200GE) +* `400gbase-cr4` - 400GBASE-CR4 (400GE) +* `400gbase-dr4` - 400GBASE-DR4 (400GE) +* `400gbase-er8` - 400GBASE-ER8 (400GE) +* `400gbase-fr4` - 400GBASE-FR4 (400GE) +* `400gbase-fr8` - 400GBASE-FR8 (400GE) +* `400gbase-lr4` - 400GBASE-LR4 (400GE) +* `400gbase-lr8` - 400GBASE-LR8 (400GE) +* `400gbase-sr4` - 400GBASE-SR4 (400GE) +* `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) +* `400gbase-sr8` - 400GBASE-SR8 (400GE) +* `400gbase-sr16` - 400GBASE-SR16 (400GE) +* `400gbase-vr4` - 400GBASE-VR4 (400GE) +* `400gbase-zr` - 400GBASE-ZR (400GE) +* `800gbase-cr8` - 800GBASE-CR8 (800GE) +* `800gbase-dr8` - 800GBASE-DR8 (800GE) +* `800gbase-sr8` - 800GBASE-SR8 (800GE) +* `800gbase-vr8` - 800GBASE-VR8 (800GE) +* `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) +* `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) +* `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) +* `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) -* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) +* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) -* `50gbase-x-sfp56` - SFP56 (50GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) +* `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) -* `200gbase-x-cfp2` - CFP2 (200GE) -* `400gbase-x-cfp2` - CFP2 (400GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) -* `100gbase-x-sfpdd` - SFP-DD (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) +* `100gbase-x-sfpdd` - SFP-DD (100GE) +* `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) -* `400gbase-x-osfp` - OSFP (400GE) -* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `400gbase-x-cdfp` - CDFP (400GE) +* `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) -* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `400gbase-x-osfp` - OSFP (400GE) +* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) +* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) +* `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) +* `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) @@ -97,14 +180,15 @@ parameters: * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) +* `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g -* `ieee802.11n` - IEEE 802.11n -* `ieee802.11ac` - IEEE 802.11ac -* `ieee802.11ad` - IEEE 802.11ad -* `ieee802.11ax` - IEEE 802.11ax -* `ieee802.11ay` - IEEE 802.11ay -* `ieee802.11be` - IEEE 802.11be +* `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) +* `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) +* `ieee802.11ad` - IEEE 802.11ad (WiGig) +* `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) +* `ieee802.11ay` - IEEE 802.11ay (WiGig) +* `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) diff --git a/actions/post.dcim.interfaces.yaml b/actions/post.dcim.interfaces.yaml index aaa5e083..5cfcf40e 100644 --- a/actions/post.dcim.interfaces.yaml +++ b/actions/post.dcim.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of interface objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" vdcs: required: false @@ -30,7 +30,7 @@ parameters: description: "Vdcs" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -46,50 +46,133 @@ parameters: description: "* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) -* `100base-fx` - 100BASE-FX (10/100ME FIBER) -* `100base-lfx` - 100BASE-LFX (10/100ME FIBER) +* `100base-fx` - 100BASE-FX (10/100ME) +* `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) -* `100base-t1` - 100BASE-T1 (10/100ME Single Pair) -* `1000base-t` - 1000BASE-T (1GE) -* `1000base-sx` - 1000BASE-SX (1GE) +* `100base-t1` - 100BASE-T1 (10/100ME) +* `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) +* `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) +* `1000base-cwdm` - 1000BASE-CWDM (1GE) +* `1000base-cx` - 1000BASE-CX (1GE DAC) +* `1000base-dwdm` - 1000BASE-DWDM (1GE) +* `1000base-ex` - 1000BASE-EX (1GE) +* `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) +* `1000base-lx10` - 1000BASE-LX10/LH (1GE) +* `1000base-sx` - 1000BASE-SX (1GE) +* `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) +* `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) +* `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) +* `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) +* `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) +* `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) +* `10gbase-er` - 10GBASE-ER (10GE) +* `10gbase-lr` - 10GBASE-LR (10GE) +* `10gbase-lrm` - 10GBASE-LRM (10GE) +* `10gbase-lx4` - 10GBASE-LX4 (10GE) +* `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) -* `10gbase-cx4` - 10GBASE-CX4 (10GE) +* `10gbase-zr` - 10GBASE-ZR (10GE) +* `25gbase-cr` - 25GBASE-CR (25GE DAC) +* `25gbase-er` - 25GBASE-ER (25GE) +* `25gbase-lr` - 25GBASE-LR (25GE) +* `25gbase-sr` - 25GBASE-SR (25GE) +* `25gbase-t` - 25GBASE-T (25GE) +* `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) +* `40gbase-er4` - 40GBASE-ER4 (40GE) +* `40gbase-fr4` - 40GBASE-FR4 (40GE) +* `40gbase-lr4` - 40GBASE-LR4 (40GE) +* `40gbase-sr4` - 40GBASE-SR4 (40GE) +* `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) +* `50gbase-cr` - 50GBASE-CR (50GE DAC) +* `50gbase-er` - 50GBASE-ER (50GE) +* `50gbase-fr` - 50GBASE-FR (50GE) +* `50gbase-lr` - 50GBASE-LR (50GE) +* `50gbase-sr` - 50GBASE-SR (50GE) +* `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) +* `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) +* `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) +* `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) +* `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) +* `100gbase-dr` - 100GBASE-DR (100GE) +* `100gbase-er4` - 100GBASE-ER4 (100GE) +* `100gbase-fr1` - 100GBASE-FR1 (100GE) +* `100gbase-lr1` - 100GBASE-LR1 (100GE) +* `100gbase-lr4` - 100GBASE-LR4 (100GE) +* `100gbase-sr1` - 100GBASE-SR1 (100GE) +* `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) +* `100gbase-sr2` - 100GBASE-SR2 (100GE) +* `100gbase-sr4` - 100GBASE-SR4 (100GE) +* `100gbase-sr10` - 100GBASE-SR10 (100GE) +* `100gbase-zr` - 100GBASE-ZR (100GE) +* `200gbase-cr2` - 200GBASE-CR2 (200GE) +* `200gbase-cr4` - 200GBASE-CR4 (200GE) +* `200gbase-dr4` - 200GBASE-DR4 (200GE) +* `200gbase-er4` - 200GBASE-ER4 (200GE) +* `200gbase-fr4` - 200GBASE-FR4 (200GE) +* `200gbase-lr4` - 200GBASE-LR4 (200GE) +* `200gbase-sr2` - 200GBASE-SR2 (200GE) +* `200gbase-sr4` - 200GBASE-SR4 (200GE) +* `200gbase-vr2` - 200GBASE-VR2 (200GE) +* `400gbase-cr4` - 400GBASE-CR4 (400GE) +* `400gbase-dr4` - 400GBASE-DR4 (400GE) +* `400gbase-er8` - 400GBASE-ER8 (400GE) +* `400gbase-fr4` - 400GBASE-FR4 (400GE) +* `400gbase-fr8` - 400GBASE-FR8 (400GE) +* `400gbase-lr4` - 400GBASE-LR4 (400GE) +* `400gbase-lr8` - 400GBASE-LR8 (400GE) +* `400gbase-sr4` - 400GBASE-SR4 (400GE) +* `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) +* `400gbase-sr8` - 400GBASE-SR8 (400GE) +* `400gbase-sr16` - 400GBASE-SR16 (400GE) +* `400gbase-vr4` - 400GBASE-VR4 (400GE) +* `400gbase-zr` - 400GBASE-ZR (400GE) +* `800gbase-cr8` - 800GBASE-CR8 (800GE) +* `800gbase-dr8` - 800GBASE-DR8 (800GE) +* `800gbase-sr8` - 800GBASE-SR8 (800GE) +* `800gbase-vr8` - 800GBASE-VR8 (800GE) +* `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) +* `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) +* `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) +* `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) -* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) +* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) -* `50gbase-x-sfp56` - SFP56 (50GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) +* `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) -* `200gbase-x-cfp2` - CFP2 (200GE) -* `400gbase-x-cfp2` - CFP2 (400GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) -* `100gbase-x-sfpdd` - SFP-DD (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) +* `100gbase-x-sfpdd` - SFP-DD (100GE) +* `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) -* `400gbase-x-osfp` - OSFP (400GE) -* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `400gbase-x-cdfp` - CDFP (400GE) +* `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) -* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `400gbase-x-osfp` - OSFP (400GE) +* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) +* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) +* `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) +* `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) @@ -101,14 +184,15 @@ parameters: * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) +* `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g -* `ieee802.11n` - IEEE 802.11n -* `ieee802.11ac` - IEEE 802.11ac -* `ieee802.11ad` - IEEE 802.11ad -* `ieee802.11ax` - IEEE 802.11ax -* `ieee802.11ay` - IEEE 802.11ay -* `ieee802.11be` - IEEE 802.11be +* `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) +* `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) +* `ieee802.11ad` - IEEE 802.11ad (WiGig) +* `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) +* `ieee802.11ay` - IEEE 802.11ay (WiGig) +* `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) @@ -197,7 +281,7 @@ parameters: description: "Mtu" primary_mac_address: required: false - type: object + type: integer description: "Primary mac address" speed: required: false @@ -268,7 +352,7 @@ parameters: description: "Transmit power (dBm)" untagged_vlan: required: false - type: object + type: integer description: "Untagged vlan" tagged_vlans: required: false @@ -276,11 +360,11 @@ parameters: description: "Tagged vlans" qinq_svlan: required: false - type: object + type: integer description: "Qinq svlan" vlan_translation_policy: required: false - type: object + type: integer description: "Vlan translation policy" mark_connected: required: false @@ -292,8 +376,12 @@ parameters: description: "Wireless lans" vrf: required: false - type: object + type: integer description: "Vrf" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.inventory_item_roles.yaml b/actions/post.dcim.inventory_item_roles.yaml index 615a26d3..475d5776 100644 --- a/actions/post.dcim.inventory_item_roles.yaml +++ b/actions/post.dcim.inventory_item_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of inventory item role objects." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.dcim.inventory_item_templates.yaml b/actions/post.dcim.inventory_item_templates.yaml index d61953ce..cb910ad6 100644 --- a/actions/post.dcim.inventory_item_templates.yaml +++ b/actions/post.dcim.inventory_item_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of inventory item template objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" parent: required: false @@ -38,11 +38,11 @@ parameters: description: "Physical label" role: required: false - type: object + type: integer description: "Role" manufacturer: required: false - type: object + type: integer description: "Manufacturer" part_id: required: false diff --git a/actions/post.dcim.inventory_items.yaml b/actions/post.dcim.inventory_items.yaml index 5909d4ab..35e8cd80 100644 --- a/actions/post.dcim.inventory_items.yaml +++ b/actions/post.dcim.inventory_items.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of inventory item objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" parent: required: false @@ -47,11 +47,11 @@ parameters: * `decommissioning` - Decommissioning" role: required: false - type: object + type: integer description: "Role" manufacturer: required: false - type: object + type: integer description: "Manufacturer" part_id: required: false @@ -81,6 +81,10 @@ parameters: required: false type: integer description: "Component id" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.locations.yaml b/actions/post.dcim.locations.yaml index 8e1a2034..220fd663 100644 --- a/actions/post.dcim.locations.yaml +++ b/actions/post.dcim.locations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of location objects." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Slug" site: required: false - type: object + type: integer description: "Site" parent: required: false @@ -46,7 +46,7 @@ parameters: * `retired` - Retired" tenant: required: false - type: object + type: integer description: "Tenant" facility: required: false @@ -64,6 +64,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.mac_addresses.yaml b/actions/post.dcim.mac_addresses.yaml index 8a64f87f..074c27bf 100644 --- a/actions/post.dcim.mac_addresses.yaml +++ b/actions/post.dcim.mac_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of MAC address objects." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.manufacturers.yaml b/actions/post.dcim.manufacturers.yaml index f7569a12..5b160295 100644 --- a/actions/post.dcim.manufacturers.yaml +++ b/actions/post.dcim.manufacturers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of manufacturer objects." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.dcim.module_bay_templates.yaml b/actions/post.dcim.module_bay_templates.yaml index 6ad3face..db665f14 100644 --- a/actions/post.dcim.module_bay_templates.yaml +++ b/actions/post.dcim.module_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of module bay template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Identifier to reference when renaming installed components" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string diff --git a/actions/post.dcim.module_bays.yaml b/actions/post.dcim.module_bays.yaml index 91cd2789..5f994f52 100644 --- a/actions/post.dcim.module_bays.yaml +++ b/actions/post.dcim.module_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of module bay objects." enabled: true entry_point: run.py @@ -22,20 +22,16 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false type: string description: "Name" - installed_module: - required: false - type: object - description: "Installed module" label: required: false type: string @@ -44,10 +40,22 @@ parameters: required: false type: string description: "Identifier to reference when renaming installed components" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string description: "Description" + installed_module: + required: false + type: integer + description: "Installed module" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.module_type_profiles.yaml b/actions/post.dcim.module_type_profiles.yaml index d6cb2b5e..2bcad25e 100644 --- a/actions/post.dcim.module_type_profiles.yaml +++ b/actions/post.dcim.module_type_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of module type profile objects." enabled: true entry_point: run.py @@ -32,6 +32,10 @@ parameters: required: false type: object description: "Schema" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.module_types.yaml b/actions/post.dcim.module_types.yaml index 583c7794..401572be 100644 --- a/actions/post.dcim.module_types.yaml +++ b/actions/post.dcim.module_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of module type objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. profile: required: false - type: object + type: integer description: "Profile" manufacturer: required: false - type: object + type: integer description: "Manufacturer" model: required: false @@ -64,6 +64,10 @@ parameters: required: false type: object description: "Attributes" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.modules.yaml b/actions/post.dcim.modules.yaml index 68ef5716..c7fb803c 100644 --- a/actions/post.dcim.modules.yaml +++ b/actions/post.dcim.modules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of module objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module_bay: required: false @@ -30,7 +30,7 @@ parameters: description: "Module bay" module_type: required: false - type: object + type: integer description: "Module type" status: required: false @@ -53,6 +53,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -65,4 +69,12 @@ parameters: required: false type: object description: "Custom fields" + replicate_components: + required: false + type: boolean + description: "Automatically populate components associated with this module type (default: true)" + adopt_components: + required: false + type: boolean + description: "Adopt already existing components" runner_type: python-script diff --git a/actions/post.dcim.platforms.yaml b/actions/post.dcim.platforms.yaml index b3f1803e..6688030b 100644 --- a/actions/post.dcim.platforms.yaml +++ b/actions/post.dcim.platforms.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of platform objects." enabled: true entry_point: run.py @@ -20,6 +20,10 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + parent: + required: false + type: integer + description: "Parent" name: required: false type: string @@ -30,16 +34,24 @@ parameters: description: "Slug" manufacturer: required: false - type: object + type: integer description: "Manufacturer" config_template: required: false - type: object + type: integer description: "Config template" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.dcim.power_feeds.yaml b/actions/post.dcim.power_feeds.yaml index 166a1105..82afdc0c 100644 --- a/actions/post.dcim.power_feeds.yaml +++ b/actions/post.dcim.power_feeds.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of power feed objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. power_panel: required: false - type: object + type: integer description: "Power panel" rack: required: false - type: object + type: integer description: "Rack" name: required: false @@ -76,8 +76,12 @@ parameters: description: "Description" tenant: required: false - type: object + type: integer description: "Tenant" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.power_outlet_templates.yaml b/actions/post.dcim.power_outlet_templates.yaml index 5b95a836..da0a277b 100644 --- a/actions/post.dcim.power_outlet_templates.yaml +++ b/actions/post.dcim.power_outlet_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of power outlet template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -43,6 +43,7 @@ parameters: * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 +* `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -125,6 +126,7 @@ parameters: * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 @@ -137,9 +139,13 @@ parameters: * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other" + color: + required: false + type: string + description: "Color" power_port: required: false - type: object + type: integer description: "Power port" feed_leg: required: false diff --git a/actions/post.dcim.power_outlets.yaml b/actions/post.dcim.power_outlets.yaml index a458d528..80b9fa6e 100644 --- a/actions/post.dcim.power_outlets.yaml +++ b/actions/post.dcim.power_outlets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of power outlet objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -45,6 +45,7 @@ parameters: * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 +* `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -127,6 +128,7 @@ parameters: * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 @@ -151,7 +153,7 @@ parameters: description: "Color" power_port: required: false - type: object + type: integer description: "Power port" feed_leg: required: false @@ -169,6 +171,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.power_panels.yaml b/actions/post.dcim.power_panels.yaml index c5aeeaab..8e6cec7b 100644 --- a/actions/post.dcim.power_panels.yaml +++ b/actions/post.dcim.power_panels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of power panel objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.power_port_templates.yaml b/actions/post.dcim.power_port_templates.yaml index 094aea09..d91f4602 100644 --- a/actions/post.dcim.power_port_templates.yaml +++ b/actions/post.dcim.power_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of power port template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -43,6 +43,7 @@ parameters: * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 +* `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -133,6 +134,7 @@ parameters: * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid diff --git a/actions/post.dcim.power_ports.yaml b/actions/post.dcim.power_ports.yaml index 6f06d0af..ea014215 100644 --- a/actions/post.dcim.power_ports.yaml +++ b/actions/post.dcim.power_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of power port objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -45,6 +45,7 @@ parameters: * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 +* `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -135,6 +136,7 @@ parameters: * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid @@ -161,6 +163,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.rack_groups.yaml b/actions/post.dcim.rack_groups.yaml new file mode 100644 index 00000000..e86f3db3 --- /dev/null +++ b/actions/post.dcim.rack_groups.yaml @@ -0,0 +1,51 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Post a list of rack group objects." +enabled: true +entry_point: run.py +name: post.dcim.rack_groups +parameters: + endpoint_uri: + default: "/dcim/rack-groups/" + immutable: true + type: string + http_verb: + default: post + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + slug: + required: false + type: string + description: "Slug" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" +runner_type: python-script diff --git a/actions/post.dcim.rack_reservations.yaml b/actions/post.dcim.rack_reservations.yaml index b0adccd6..bf56b911 100644 --- a/actions/post.dcim.rack_reservations.yaml +++ b/actions/post.dcim.rack_reservations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of rack reservation objects." enabled: true entry_point: run.py @@ -22,24 +22,34 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. rack: required: false - type: object + type: integer description: "Rack" units: required: false type: array description: "Units" + status: + required: false + type: string + description: "* `pending` - Pending +* `active` - Active +* `stale` - Stale" user: required: false - type: object + type: integer description: "User" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.rack_roles.yaml b/actions/post.dcim.rack_roles.yaml index a2987965..5cf2905f 100644 --- a/actions/post.dcim.rack_roles.yaml +++ b/actions/post.dcim.rack_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of rack role objects." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.dcim.rack_types.yaml b/actions/post.dcim.rack_types.yaml index 13b61e0a..bb8eaee1 100644 --- a/actions/post.dcim.rack_types.yaml +++ b/actions/post.dcim.rack_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of rack type objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. manufacturer: required: false - type: object + type: integer description: "Manufacturer" model: required: false @@ -103,6 +103,10 @@ parameters: required: false type: integer description: "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails." + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.racks.yaml b/actions/post.dcim.racks.yaml index 4597d24c..2599613d 100644 --- a/actions/post.dcim.racks.yaml +++ b/actions/post.dcim.racks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of rack objects." enabled: true entry_point: run.py @@ -30,15 +30,19 @@ parameters: description: "Facility id" site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" + group: + required: false + type: integer + description: "Group" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -50,7 +54,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" serial: required: false @@ -62,7 +66,7 @@ parameters: description: "A unique tag used to identify this rack" rack_type: required: false - type: object + type: integer description: "Rack type" form_factor: required: false @@ -140,6 +144,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.rear_port_templates.yaml b/actions/post.dcim.rear_port_templates.yaml index e5acfc75..0e842411 100644 --- a/actions/post.dcim.rear_port_templates.yaml +++ b/actions/post.dcim.rear_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of rear port template objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -105,6 +105,10 @@ parameters: required: false type: integer description: "Positions" + front_ports: + required: false + type: array + description: "Front ports" description: required: false type: string diff --git a/actions/post.dcim.rear_ports.yaml b/actions/post.dcim.rear_ports.yaml index 84d9b6e8..11650141 100644 --- a/actions/post.dcim.rear_ports.yaml +++ b/actions/post.dcim.rear_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of rear port objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -104,7 +104,11 @@ parameters: positions: required: false type: integer - description: "Number of front ports which may be mapped" + description: "Positions" + front_ports: + required: false + type: array + description: "Front ports" description: required: false type: string @@ -113,6 +117,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.dcim.regions.yaml b/actions/post.dcim.regions.yaml index eedb555f..6dc15d99 100644 --- a/actions/post.dcim.regions.yaml +++ b/actions/post.dcim.regions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of region objects." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.site_groups.yaml b/actions/post.dcim.site_groups.yaml index 59bba924..c2732749 100644 --- a/actions/post.dcim.site_groups.yaml +++ b/actions/post.dcim.site_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of site group objects." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.sites.yaml b/actions/post.dcim.sites.yaml index 034abf17..9f5d0a36 100644 --- a/actions/post.dcim.sites.yaml +++ b/actions/post.dcim.sites.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of site objects." enabled: true entry_point: run.py @@ -38,15 +38,15 @@ parameters: * `retired` - Retired" region: required: false - type: object + type: integer description: "Region" group: required: false - type: object + type: integer description: "Group" tenant: required: false - type: object + type: integer description: "Tenant" facility: required: false @@ -76,6 +76,10 @@ parameters: required: false type: integer description: "GPS coordinate in decimal format (xx.yyyyyy)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.virtual_chassis.yaml b/actions/post.dcim.virtual_chassis.yaml index fb4b5d5d..c7ecd1b7 100644 --- a/actions/post.dcim.virtual_chassis.yaml +++ b/actions/post.dcim.virtual_chassis.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of virtual chassis objects." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.dcim.virtual_device_contexts.yaml b/actions/post.dcim.virtual_device_contexts.yaml index 50f1c130..463cbe99 100644 --- a/actions/post.dcim.virtual_device_contexts.yaml +++ b/actions/post.dcim.virtual_device_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of virtual device context objects." enabled: true entry_point: run.py @@ -26,7 +26,7 @@ parameters: description: "Name" device: required: false - type: object + type: integer description: "Device" identifier: required: false @@ -34,15 +34,15 @@ parameters: description: "Identifier" tenant: required: false - type: object + type: integer description: "Tenant" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" status: required: false @@ -54,6 +54,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.extras.bookmarks.yaml b/actions/post.extras.bookmarks.yaml index ee4abc0e..1e57fc12 100644 --- a/actions/post.extras.bookmarks.yaml +++ b/actions/post.extras.bookmarks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of bookmark objects." enabled: true entry_point: run.py @@ -30,6 +30,6 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" runner_type: python-script diff --git a/actions/post.extras.config_context_profiles.yaml b/actions/post.extras.config_context_profiles.yaml new file mode 100644 index 00000000..6790778b --- /dev/null +++ b/actions/post.extras.config_context_profiles.yaml @@ -0,0 +1,51 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Post a list of config context profile objects." +enabled: true +entry_point: run.py +name: post.extras.config_context_profiles +parameters: + endpoint_uri: + default: "/extras/config-context-profiles/" + immutable: true + type: string + http_verb: + default: post + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + schema: + required: false + type: object + description: "A JSON schema specifying the structure of the context data for this profile" + tags: + required: false + type: array + description: "Array of tag strings" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + data_source: + required: false + type: integer + description: "Data source" +runner_type: python-script diff --git a/actions/post.extras.config_contexts.yaml b/actions/post.extras.config_contexts.yaml index 9097c214..1a7dca70 100644 --- a/actions/post.extras.config_contexts.yaml +++ b/actions/post.extras.config_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of config context objects." enabled: true entry_point: run.py @@ -28,6 +28,10 @@ parameters: required: false type: integer description: "Weight" + profile: + required: false + type: integer + description: "Profile" description: required: false type: string @@ -84,13 +88,17 @@ parameters: required: false type: array description: "Tenants" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array description: "Array of tag strings" data_source: required: false - type: object + type: integer description: "Data source" data: required: false diff --git a/actions/post.extras.config_templates.yaml b/actions/post.extras.config_templates.yaml index ef5ae139..3f5b65a7 100644 --- a/actions/post.extras.config_templates.yaml +++ b/actions/post.extras.config_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of config template objects." enabled: true entry_point: run.py @@ -52,10 +52,22 @@ parameters: required: false type: boolean description: "Download file as attachment" + debug: + required: false + type: boolean + description: "Enable verbose error output when rendering this template. Not recommended for production use." data_source: required: false - type: object + type: integer description: "Data source" + auto_sync_enabled: + required: false + type: boolean + description: "Enable automatic synchronization of data when the data file is updated" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.extras.custom_field_choice_sets.yaml b/actions/post.extras.custom_field_choice_sets.yaml index 35a9783e..87c7f297 100644 --- a/actions/post.extras.custom_field_choice_sets.yaml +++ b/actions/post.extras.custom_field_choice_sets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of custom field choice set objects." enabled: true entry_point: run.py @@ -40,8 +40,16 @@ parameters: required: false type: array description: "Extra choices" + choice_colors: + required: false + type: object + description: "Choice colors" order_alphabetically: required: false type: boolean description: "Choices are automatically ordered alphabetically" + owner: + required: false + type: integer + description: "Owner" runner_type: python-script diff --git a/actions/post.extras.custom_fields.yaml b/actions/post.extras.custom_fields.yaml index 7fa7b22e..726beb90 100644 --- a/actions/post.extras.custom_fields.yaml +++ b/actions/post.extras.custom_fields.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of custom field objects." enabled: true entry_point: run.py @@ -126,10 +126,18 @@ parameters: required: false type: string description: "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, <code>^[A-Z]{3}$</code> will limit values to exactly three uppercase letters." - choice_set: + validation_schema: required: false type: object + description: "A JSON schema definition for validating the custom field value" + choice_set: + required: false + type: integer description: "Choice set" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.extras.custom_links.yaml b/actions/post.extras.custom_links.yaml index 4aec36fd..1650b924 100644 --- a/actions/post.extras.custom_links.yaml +++ b/actions/post.extras.custom_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of custom link objects." enabled: true entry_point: run.py @@ -72,4 +72,8 @@ parameters: required: false type: boolean description: "Force link to open in a new window" + owner: + required: false + type: integer + description: "Owner" runner_type: python-script diff --git a/actions/post.extras.event_rules.yaml b/actions/post.extras.event_rules.yaml index 8746ff68..8bd31b6b 100644 --- a/actions/post.extras.event_rules.yaml +++ b/actions/post.extras.event_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of event rule objects." enabled: true entry_point: run.py @@ -62,6 +62,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.extras.export_templates.yaml b/actions/post.extras.export_templates.yaml index 446f37cd..4916e62b 100644 --- a/actions/post.extras.export_templates.yaml +++ b/actions/post.extras.export_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of export template objects." enabled: true entry_point: run.py @@ -58,6 +58,10 @@ parameters: description: "Download file as attachment" data_source: required: false - type: object + type: integer description: "Data source" + owner: + required: false + type: integer + description: "Owner" runner_type: python-script diff --git a/actions/post.extras.image_attachments.yaml b/actions/post.extras.image_attachments.yaml index cd4822f6..6a25013e 100644 --- a/actions/post.extras.image_attachments.yaml +++ b/actions/post.extras.image_attachments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of image attachment objects." enabled: true entry_point: run.py @@ -36,4 +36,8 @@ parameters: required: false type: string description: "Image" + description: + required: false + type: string + description: "Description" runner_type: python-script diff --git a/actions/post.extras.journal_entries.yaml b/actions/post.extras.journal_entries.yaml index c913e746..798cf5a1 100644 --- a/actions/post.extras.journal_entries.yaml +++ b/actions/post.extras.journal_entries.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of journal entry objects." enabled: true entry_point: run.py diff --git a/actions/post.extras.notification_groups.yaml b/actions/post.extras.notification_groups.yaml index fdafd7ca..4831f623 100644 --- a/actions/post.extras.notification_groups.yaml +++ b/actions/post.extras.notification_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of notification group objects." enabled: true entry_point: run.py diff --git a/actions/post.extras.notifications.yaml b/actions/post.extras.notifications.yaml index cb14f44a..7276aeef 100644 --- a/actions/post.extras.notifications.yaml +++ b/actions/post.extras.notifications.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of notification objects." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" read: required: false diff --git a/actions/post.extras.saved_filters.yaml b/actions/post.extras.saved_filters.yaml index d0f63402..25cfc9a6 100644 --- a/actions/post.extras.saved_filters.yaml +++ b/actions/post.extras.saved_filters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of saved filter objects." enabled: true entry_point: run.py @@ -56,4 +56,8 @@ parameters: required: false type: object description: "Parameters" + owner: + required: false + type: integer + description: "Owner" runner_type: python-script diff --git a/actions/post.extras.scripts.upload.yaml b/actions/post.extras.scripts.upload.yaml new file mode 100644 index 00000000..1cfc1469 --- /dev/null +++ b/actions/post.extras.scripts.upload.yaml @@ -0,0 +1,27 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Post a list of script module objects." +enabled: true +entry_point: run.py +name: post.extras.scripts.upload +parameters: + endpoint_uri: + default: "/extras/scripts/upload/" + immutable: true + type: string + http_verb: + default: post + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + file: + required: false + type: string + description: "File" +runner_type: python-script diff --git a/actions/post.extras.scripts.yaml b/actions/post.extras.scripts.yaml index 1e34aaa9..e1dedd88 100644 --- a/actions/post.extras.scripts.yaml +++ b/actions/post.extras.scripts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of script objects." enabled: true entry_point: run.py diff --git a/actions/post.extras.subscriptions.yaml b/actions/post.extras.subscriptions.yaml index e7ac1b8a..15bbc7dc 100644 --- a/actions/post.extras.subscriptions.yaml +++ b/actions/post.extras.subscriptions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of subscription objects." enabled: true entry_point: run.py @@ -30,6 +30,6 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" runner_type: python-script diff --git a/actions/post.extras.table_configs.yaml b/actions/post.extras.table_configs.yaml index 98230137..d4a737a5 100644 --- a/actions/post.extras.table_configs.yaml +++ b/actions/post.extras.table_configs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of table config objects." enabled: true entry_point: run.py diff --git a/actions/post.extras.tags.yaml b/actions/post.extras.tags.yaml index bd5d1913..aa8f01c9 100644 --- a/actions/post.extras.tags.yaml +++ b/actions/post.extras.tags.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of tag objects." enabled: true entry_point: run.py diff --git a/actions/post.extras.webhooks.yaml b/actions/post.extras.webhooks.yaml index 74330b9d..b1c5e139 100644 --- a/actions/post.extras.webhooks.yaml +++ b/actions/post.extras.webhooks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of webhook objects." enabled: true entry_point: run.py @@ -68,6 +68,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.ipam.aggregates.yaml b/actions/post.ipam.aggregates.yaml index cec572bd..af73e935 100644 --- a/actions/post.ipam.aggregates.yaml +++ b/actions/post.ipam.aggregates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of aggregate objects." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Prefix" rir: required: false - type: object + type: integer description: "Rir" tenant: required: false - type: object + type: integer description: "Tenant" date_added: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.asn_ranges.yaml b/actions/post.ipam.asn_ranges.yaml index dbf42c85..f9a223b2 100644 --- a/actions/post.ipam.asn_ranges.yaml +++ b/actions/post.ipam.asn_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of ASN range objects." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Slug" rir: required: false - type: object + type: integer description: "Rir" start: required: false @@ -42,12 +42,20 @@ parameters: description: "End" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.ipam.asns.yaml b/actions/post.ipam.asns.yaml index 9550c097..ccca9cb8 100644 --- a/actions/post.ipam.asns.yaml +++ b/actions/post.ipam.asns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of ASN objects." enabled: true entry_point: run.py @@ -26,16 +26,24 @@ parameters: description: "16- or 32-bit autonomous system number" rir: required: false - type: object + type: integer description: "Rir" + role: + required: false + type: integer + description: "Role" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -48,4 +56,8 @@ parameters: required: false type: object description: "Custom fields" + sites: + required: false + type: array + description: "Sites" runner_type: python-script diff --git a/actions/post.ipam.fhrp_group_assignments.yaml b/actions/post.ipam.fhrp_group_assignments.yaml index bd22a80e..aeaf53dc 100644 --- a/actions/post.ipam.fhrp_group_assignments.yaml +++ b/actions/post.ipam.fhrp_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of FHRP group assignment objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. group: required: false - type: object + type: integer description: "Group" interface_type: required: false diff --git a/actions/post.ipam.fhrp_groups.yaml b/actions/post.ipam.fhrp_groups.yaml index 151eb6ed..04462c45 100644 --- a/actions/post.ipam.fhrp_groups.yaml +++ b/actions/post.ipam.fhrp_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of FHRP group objects." enabled: true entry_point: run.py @@ -50,6 +50,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.ip_addresses.yaml b/actions/post.ipam.ip_addresses.yaml index dd5b3b96..cd62e897 100644 --- a/actions/post.ipam.ip_addresses.yaml +++ b/actions/post.ipam.ip_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of IP address objects." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Address" vrf: required: false - type: object + type: integer description: "Vrf" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -75,6 +75,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.ip_ranges.yaml b/actions/post.ipam.ip_ranges.yaml index e54063b2..d24fd35b 100644 --- a/actions/post.ipam.ip_ranges.yaml +++ b/actions/post.ipam.ip_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of IP range objects." enabled: true entry_point: run.py @@ -30,11 +30,11 @@ parameters: description: "End address" vrf: required: false - type: object + type: integer description: "Vrf" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -46,12 +46,16 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -71,5 +75,5 @@ parameters: mark_utilized: required: false type: boolean - description: "Report space as 100% utilized" + description: "Report space as fully utilized" runner_type: python-script diff --git a/actions/post.ipam.prefixes.yaml b/actions/post.ipam.prefixes.yaml index 6e33e3a4..284b1da7 100644 --- a/actions/post.ipam.prefixes.yaml +++ b/actions/post.ipam.prefixes.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of prefix objects." enabled: true entry_point: run.py @@ -26,7 +26,7 @@ parameters: description: "Prefix" vrf: required: false - type: object + type: integer description: "Vrf" scope_type: required: false @@ -38,11 +38,11 @@ parameters: description: "Scope id" tenant: required: false - type: object + type: integer description: "Tenant" vlan: required: false - type: object + type: integer description: "Vlan" status: required: false @@ -55,7 +55,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" is_pool: required: false @@ -69,6 +69,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.rirs.yaml b/actions/post.ipam.rirs.yaml index ac594813..aad366fa 100644 --- a/actions/post.ipam.rirs.yaml +++ b/actions/post.ipam.rirs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of RIR objects." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.ipam.roles.yaml b/actions/post.ipam.roles.yaml index 78886703..ec34fae5 100644 --- a/actions/post.ipam.roles.yaml +++ b/actions/post.ipam.roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of role objects." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.ipam.route_targets.yaml b/actions/post.ipam.route_targets.yaml index 2ae5e905..854e0967 100644 --- a/actions/post.ipam.route_targets.yaml +++ b/actions/post.ipam.route_targets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of route target objects." enabled: true entry_point: run.py @@ -26,12 +26,16 @@ parameters: description: "Route target value (formatted in accordance with RFC 4360)" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.service_templates.yaml b/actions/post.ipam.service_templates.yaml index d8e0d484..1f97580b 100644 --- a/actions/post.ipam.service_templates.yaml +++ b/actions/post.ipam.service_templates.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Post a list of service template objects." +# NetBox API version: 4.6 +description: "Post a list of application service template objects." enabled: true entry_point: run.py name: post.ipam.service_templates @@ -38,6 +38,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.services.yaml b/actions/post.ipam.services.yaml index f2c0118b..54a32bf2 100644 --- a/actions/post.ipam.services.yaml +++ b/actions/post.ipam.services.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Post a list of service objects." +# NetBox API version: 4.6 +description: "Post a list of application service objects." enabled: true entry_point: run.py name: post.ipam.services @@ -50,6 +50,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.vlan_groups.yaml b/actions/post.ipam.vlan_groups.yaml index 49c44862..7854b4d0 100644 --- a/actions/post.ipam.vlan_groups.yaml +++ b/actions/post.ipam.vlan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of VLAN group objects." enabled: true entry_point: run.py @@ -42,12 +42,20 @@ parameters: description: "Vid ranges" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.ipam.vlan_translation_policies.yaml b/actions/post.ipam.vlan_translation_policies.yaml index 6845daa1..15cee142 100644 --- a/actions/post.ipam.vlan_translation_policies.yaml +++ b/actions/post.ipam.vlan_translation_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of VLAN translation policy objects." enabled: true entry_point: run.py @@ -28,4 +28,12 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" runner_type: python-script diff --git a/actions/post.ipam.vlan_translation_rules.yaml b/actions/post.ipam.vlan_translation_rules.yaml index 835e22e8..dfeb5d4c 100644 --- a/actions/post.ipam.vlan_translation_rules.yaml +++ b/actions/post.ipam.vlan_translation_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of VLAN translation rule objects." enabled: true entry_point: run.py diff --git a/actions/post.ipam.vlans.yaml b/actions/post.ipam.vlans.yaml index 446d0c13..a18f7eb7 100644 --- a/actions/post.ipam.vlans.yaml +++ b/actions/post.ipam.vlans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of VLAN objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. site: required: false - type: object + type: integer description: "Site" group: required: false - type: object + type: integer description: "Group" vid: required: false @@ -38,7 +38,7 @@ parameters: description: "Name" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -50,7 +50,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" description: required: false @@ -64,6 +64,10 @@ parameters: required: false type: integer description: "Qinq svlan" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.ipam.vrfs.yaml b/actions/post.ipam.vrfs.yaml index abe40b3e..d29d9c86 100644 --- a/actions/post.ipam.vrfs.yaml +++ b/actions/post.ipam.vrfs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of VRF objects." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Route distinguisher" tenant: required: false - type: object + type: integer description: "Tenant" enforce_unique: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.tenancy.contact_assignments.yaml b/actions/post.tenancy.contact_assignments.yaml index 32eb21f5..6cf4d907 100644 --- a/actions/post.tenancy.contact_assignments.yaml +++ b/actions/post.tenancy.contact_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of contact assignment objects." enabled: true entry_point: run.py @@ -30,11 +30,11 @@ parameters: description: "Object id" contact: required: false - type: object + type: integer description: "Contact" role: required: false - type: object + type: integer description: "Role" priority: required: false diff --git a/actions/post.tenancy.contact_groups.yaml b/actions/post.tenancy.contact_groups.yaml index f5ce15f3..cac34076 100644 --- a/actions/post.tenancy.contact_groups.yaml +++ b/actions/post.tenancy.contact_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of contact group objects." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.tenancy.contact_roles.yaml b/actions/post.tenancy.contact_roles.yaml index 8be0be3e..fdc906e8 100644 --- a/actions/post.tenancy.contact_roles.yaml +++ b/actions/post.tenancy.contact_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of contact role objects." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.tenancy.contacts.yaml b/actions/post.tenancy.contacts.yaml index f38ea93b..32e5b8c9 100644 --- a/actions/post.tenancy.contacts.yaml +++ b/actions/post.tenancy.contacts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of contact objects." enabled: true entry_point: run.py @@ -52,6 +52,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.tenancy.tenant_groups.yaml b/actions/post.tenancy.tenant_groups.yaml index 79bf8513..90d2894e 100644 --- a/actions/post.tenancy.tenant_groups.yaml +++ b/actions/post.tenancy.tenant_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of tenant group objects." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.tenancy.tenants.yaml b/actions/post.tenancy.tenants.yaml index 9e048f9a..05324ed4 100644 --- a/actions/post.tenancy.tenants.yaml +++ b/actions/post.tenancy.tenants.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of tenant objects." enabled: true entry_point: run.py @@ -30,12 +30,16 @@ parameters: description: "Slug" group: required: false - type: object + type: integer description: "Group" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.users.groups.yaml b/actions/post.users.groups.yaml index 5eeb680b..6f2cd848 100644 --- a/actions/post.users.groups.yaml +++ b/actions/post.users.groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of group objects." enabled: true entry_point: run.py diff --git a/actions/post.users.owner_groups.yaml b/actions/post.users.owner_groups.yaml new file mode 100644 index 00000000..20fd6a3a --- /dev/null +++ b/actions/post.users.owner_groups.yaml @@ -0,0 +1,31 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Post a list of owner group objects." +enabled: true +entry_point: run.py +name: post.users.owner_groups +parameters: + endpoint_uri: + default: "/users/owner-groups/" + immutable: true + type: string + http_verb: + default: post + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" +runner_type: python-script diff --git a/actions/post.dcim.cable_terminations.yaml b/actions/post.users.owners.yaml similarity index 61% rename from actions/post.dcim.cable_terminations.yaml rename to actions/post.users.owners.yaml index 5ff32cd1..9802eae5 100644 --- a/actions/post.dcim.cable_terminations.yaml +++ b/actions/post.users.owners.yaml @@ -1,12 +1,12 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Post a list of cable termination objects." +# NetBox API version: 4.6 +description: "Post a list of owner objects." enabled: true entry_point: run.py -name: post.dcim.cable_terminations +name: post.users.owners parameters: endpoint_uri: - default: "/dcim/cable-terminations/" + default: "/users/owners/" immutable: true type: string http_verb: @@ -20,20 +20,24 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. - cable: + name: + required: false + type: string + description: "Name" + group: required: false type: integer - description: "Cable" - cable_end: + description: "Group" + description: required: false type: string - description: "End" - termination_type: + description: "Description" + user_groups: required: false - type: string - description: "Termination type" - termination_id: + type: array + description: "User groups" + users: required: false - type: integer - description: "Termination id" + type: array + description: "Users" runner_type: python-script diff --git a/actions/post.users.permissions.yaml b/actions/post.users.permissions.yaml index df7b7bee..1d05d6a4 100644 --- a/actions/post.users.permissions.yaml +++ b/actions/post.users.permissions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of permission objects." enabled: true entry_point: run.py diff --git a/actions/post.users.tokens.provision.yaml b/actions/post.users.tokens.provision.yaml index d074e553..ce02f9d8 100644 --- a/actions/post.users.tokens.provision.yaml +++ b/actions/post.users.tokens.provision.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Non-authenticated REST API endpoint via which a user may create a Token." enabled: true entry_point: run.py @@ -20,14 +20,23 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + version: + required: false + type: integer + description: "* `1` - v1 +* `2` - v2" expires: required: false type: string description: "Expires" + enabled: + required: false + type: boolean + description: "Disable to temporarily revoke this token without deleting it." write_enabled: required: false type: boolean - description: "Permit create/update/delete operations using this key" + description: "Permit create/update/delete operations using this token" description: required: false type: string @@ -40,4 +49,8 @@ parameters: required: false type: string description: "Password" + token: + required: false + type: string + description: "Token" runner_type: python-script diff --git a/actions/post.users.tokens.yaml b/actions/post.users.tokens.yaml index a6e265cd..095f8821 100644 --- a/actions/post.users.tokens.yaml +++ b/actions/post.users.tokens.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of token objects." enabled: true entry_point: run.py @@ -20,10 +20,19 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + version: + required: false + type: integer + description: "* `1` - v1 +* `2` - v2" user: required: false - type: object + type: integer description: "User" + description: + required: false + type: string + description: "Description" expires: required: false type: string @@ -32,16 +41,20 @@ parameters: required: false type: string description: "Last used" - key: + enabled: required: false - type: string - description: "Key" + type: boolean + description: "Disable to temporarily revoke this token without deleting it." write_enabled: required: false type: boolean - description: "Permit create/update/delete operations using this key" - description: + description: "Permit create/update/delete operations using this token" + pepper_id: + required: false + type: integer + description: "ID of the cryptographic pepper used to hash the token (v2 only)" + token: required: false type: string - description: "Description" + description: "Token" runner_type: python-script diff --git a/actions/post.users.users.yaml b/actions/post.users.users.yaml index 225f24a2..8920f142 100644 --- a/actions/post.users.users.yaml +++ b/actions/post.users.users.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of user objects." enabled: true entry_point: run.py @@ -40,10 +40,6 @@ parameters: required: false type: string description: "Email address" - is_staff: - required: false - type: boolean - description: "Staff status" is_active: required: false type: boolean diff --git a/actions/post.virtualization.cluster_groups.yaml b/actions/post.virtualization.cluster_groups.yaml index c72f977e..654443d2 100644 --- a/actions/post.virtualization.cluster_groups.yaml +++ b/actions/post.virtualization.cluster_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of cluster group objects." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.virtualization.cluster_types.yaml b/actions/post.virtualization.cluster_types.yaml index 90a1c495..c1495f69 100644 --- a/actions/post.virtualization.cluster_types.yaml +++ b/actions/post.virtualization.cluster_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of cluster type objects." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.virtualization.clusters.yaml b/actions/post.virtualization.clusters.yaml index de5aed58..caa256c4 100644 --- a/actions/post.virtualization.clusters.yaml +++ b/actions/post.virtualization.clusters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of cluster objects." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Name" type: required: false - type: object + type: integer description: "Type" group: required: false - type: object + type: integer description: "Group" status: required: false @@ -42,7 +42,7 @@ parameters: * `offline` - Offline" tenant: required: false - type: object + type: integer description: "Tenant" scope_type: required: false @@ -56,6 +56,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.virtualization.interfaces.yaml b/actions/post.virtualization.interfaces.yaml index 69d6dc3b..26fd3fa3 100644 --- a/actions/post.virtualization.interfaces.yaml +++ b/actions/post.virtualization.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of interface objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_machine: required: false - type: object + type: integer description: "Virtual machine" name: required: false @@ -46,7 +46,7 @@ parameters: description: "Mtu" primary_mac_address: required: false - type: object + type: integer description: "Primary mac address" description: required: false @@ -63,7 +63,7 @@ parameters: * `q-in-q` - Q-in-Q (802.1ad)" untagged_vlan: required: false - type: object + type: integer description: "Untagged vlan" tagged_vlans: required: false @@ -71,16 +71,20 @@ parameters: description: "Tagged vlans" qinq_svlan: required: false - type: object + type: integer description: "Qinq svlan" vlan_translation_policy: required: false - type: object + type: integer description: "Vlan translation policy" vrf: required: false - type: object + type: integer description: "Vrf" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.virtualization.virtual_disks.yaml b/actions/post.virtualization.virtual_disks.yaml index e5140dac..6bd3ec5a 100644 --- a/actions/post.virtualization.virtual_disks.yaml +++ b/actions/post.virtualization.virtual_disks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of virtual disk objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_machine: required: false - type: object + type: integer description: "Virtual machine" name: required: false @@ -35,7 +35,11 @@ parameters: size: required: false type: integer - description: "Size (MB)" + description: "Size" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/post.virtualization.virtual_machine_types.yaml b/actions/post.virtualization.virtual_machine_types.yaml new file mode 100644 index 00000000..a211bd5f --- /dev/null +++ b/actions/post.virtualization.virtual_machine_types.yaml @@ -0,0 +1,63 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Post a list of virtual machine type objects." +enabled: true +entry_point: run.py +name: post.virtualization.virtual_machine_types +parameters: + endpoint_uri: + default: "/virtualization/virtual-machine-types/" + immutable: true + type: string + http_verb: + default: post + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + slug: + required: false + type: string + description: "Slug" + default_platform: + required: false + type: integer + description: "Default platform" + default_vcpus: + required: false + type: integer + description: "Default vcpus" + default_memory: + required: false + type: integer + description: "Default memory (MB)" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" +runner_type: python-script diff --git a/actions/post.virtualization.virtual_machines.yaml b/actions/post.virtualization.virtual_machines.yaml index 93338476..f7160aaa 100644 --- a/actions/post.virtualization.virtual_machines.yaml +++ b/actions/post.virtualization.virtual_machines.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of virtual machine objects." enabled: true entry_point: run.py @@ -24,6 +24,14 @@ parameters: required: false type: string description: "Name" + virtual_machine_type: + required: false + type: integer + description: "Virtual machine type" + role: + required: false + type: integer + description: "Role" status: required: false type: string @@ -34,41 +42,35 @@ parameters: * `failed` - Failed * `decommissioning` - Decommissioning * `paused` - Paused" + start_on_boot: + required: false + type: string + description: "* `on` - On +* `off` - Off +* `laststate` - Last State" site: required: false - type: object + type: integer description: "Site" cluster: required: false - type: object + type: integer description: "Cluster" device: required: false - type: object + type: integer description: "Device" - serial: - required: false - type: string - description: "Serial number" - role: - required: false - type: object - description: "Role" - tenant: - required: false - type: object - description: "Tenant" platform: required: false - type: object + type: integer description: "Platform" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" vcpus: required: false @@ -77,31 +79,43 @@ parameters: memory: required: false type: integer - description: "Memory (MB)" + description: "Memory" disk: required: false type: integer - description: "Disk (MB)" + description: "Disk" description: required: false type: string description: "Description" + serial: + required: false + type: string + description: "Serial number" + tenant: + required: false + type: integer + description: "Tenant" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" - config_template: + tags: required: false - type: object - description: "Config template" + type: array + description: "Array of tag strings" local_context_data: required: false type: object description: "Local config context data takes precedence over source contexts in the final rendered config context" - tags: + config_template: required: false - type: array - description: "Array of tag strings" + type: integer + description: "Config template" custom_fields: required: false type: object diff --git a/actions/post.vpn.ike_policies.yaml b/actions/post.vpn.ike_policies.yaml index b0312ef0..80fa5b63 100644 --- a/actions/post.vpn.ike_policies.yaml +++ b/actions/post.vpn.ike_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of IKE policy objects." enabled: true entry_point: run.py @@ -46,6 +46,10 @@ parameters: required: false type: string description: "Pre-shared key" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.vpn.ike_proposals.yaml b/actions/post.vpn.ike_proposals.yaml index bb5fb118..bcc4c62a 100644 --- a/actions/post.vpn.ike_proposals.yaml +++ b/actions/post.vpn.ike_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of IKE proposal objects." enabled: true entry_point: run.py @@ -87,6 +87,10 @@ parameters: required: false type: integer description: "Security association lifetime (in seconds)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.vpn.ipsec_policies.yaml b/actions/post.vpn.ipsec_policies.yaml index 451e8b70..efd29735 100644 --- a/actions/post.vpn.ipsec_policies.yaml +++ b/actions/post.vpn.ipsec_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of IPSec policy objects." enabled: true entry_point: run.py @@ -61,6 +61,10 @@ parameters: * `32` - Group 32 * `33` - Group 33 * `34` - Group 34" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.vpn.ipsec_profiles.yaml b/actions/post.vpn.ipsec_profiles.yaml index 03204585..4b7e7d5b 100644 --- a/actions/post.vpn.ipsec_profiles.yaml +++ b/actions/post.vpn.ipsec_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of IPSec profile objects." enabled: true entry_point: run.py @@ -35,12 +35,16 @@ parameters: * `ah` - AH" ike_policy: required: false - type: object + type: integer description: "Ike policy" ipsec_policy: required: false - type: object + type: integer description: "Ipsec policy" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.vpn.ipsec_proposals.yaml b/actions/post.vpn.ipsec_proposals.yaml index 0185d87d..6ce64843 100644 --- a/actions/post.vpn.ipsec_proposals.yaml +++ b/actions/post.vpn.ipsec_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of IPSec proposal objects." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: integer description: "SA lifetime (KB)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.vpn.l2vpn_terminations.yaml b/actions/post.vpn.l2vpn_terminations.yaml index 5476759a..733976c8 100644 --- a/actions/post.vpn.l2vpn_terminations.yaml +++ b/actions/post.vpn.l2vpn_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of L2VPN termination objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. l2vpn: required: false - type: object + type: integer description: "L2vpn" assigned_object_type: required: false diff --git a/actions/post.vpn.l2vpns.yaml b/actions/post.vpn.l2vpns.yaml index 29226106..d890ba0a 100644 --- a/actions/post.vpn.l2vpns.yaml +++ b/actions/post.vpn.l2vpns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of L2VPN objects." enabled: true entry_point: run.py @@ -67,13 +67,17 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" tenant: required: false - type: object + type: integer description: "Tenant" tags: required: false diff --git a/actions/post.vpn.tunnel_groups.yaml b/actions/post.vpn.tunnel_groups.yaml index 6855b618..36019d12 100644 --- a/actions/post.vpn.tunnel_groups.yaml +++ b/actions/post.vpn.tunnel_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of tunnel group objects." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/post.vpn.tunnel_terminations.yaml b/actions/post.vpn.tunnel_terminations.yaml index 070fbf1f..604783f4 100644 --- a/actions/post.vpn.tunnel_terminations.yaml +++ b/actions/post.vpn.tunnel_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of tunnel termination objects." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. tunnel: required: false - type: object + type: integer description: "Tunnel" role: required: false @@ -40,7 +40,7 @@ parameters: description: "Termination id" outside_ip: required: false - type: object + type: integer description: "Outside ip" tags: required: false diff --git a/actions/post.vpn.tunnels.yaml b/actions/post.vpn.tunnels.yaml index ac8c8d36..31d39289 100644 --- a/actions/post.vpn.tunnels.yaml +++ b/actions/post.vpn.tunnels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of tunnel objects." enabled: true entry_point: run.py @@ -32,7 +32,7 @@ parameters: * `disabled` - Disabled" group: required: false - type: object + type: integer description: "Group" encapsulation: required: false @@ -47,11 +47,11 @@ parameters: * `pptp` - PPTP" ipsec_profile: required: false - type: object + type: integer description: "Ipsec profile" tenant: required: false - type: object + type: integer description: "Tenant" tunnel_id: required: false @@ -61,6 +61,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.wireless.wireless_lan_groups.yaml b/actions/post.wireless.wireless_lan_groups.yaml index 6c48a086..c291e430 100644 --- a/actions/post.wireless.wireless_lan_groups.yaml +++ b/actions/post.wireless.wireless_lan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of wireless LAN group objects." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.wireless.wireless_lans.yaml b/actions/post.wireless.wireless_lans.yaml index 5087b95e..8020d8ee 100644 --- a/actions/post.wireless.wireless_lans.yaml +++ b/actions/post.wireless.wireless_lans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of wireless LAN objects." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Description" group: required: false - type: object + type: integer description: "Group" status: required: false @@ -41,7 +41,7 @@ parameters: * `deprecated` - Deprecated" vlan: required: false - type: object + type: integer description: "Vlan" scope_type: required: false @@ -53,7 +53,7 @@ parameters: description: "Scope id" tenant: required: false - type: object + type: integer description: "Tenant" auth_type: required: false @@ -67,6 +67,10 @@ parameters: required: false type: string description: "Pre-shared key" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/post.wireless.wireless_links.yaml b/actions/post.wireless.wireless_links.yaml index 81335f1b..5a956996 100644 --- a/actions/post.wireless.wireless_links.yaml +++ b/actions/post.wireless.wireless_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Post a list of wireless link objects." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. interface_a: required: false - type: object + type: integer description: "Interface a" interface_b: required: false - type: object + type: integer description: "Interface b" ssid: required: false @@ -40,7 +40,7 @@ parameters: * `decommissioning` - Decommissioning" tenant: required: false - type: object + type: integer description: "Tenant" auth_type: required: false @@ -69,6 +69,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.circuits.circuit_group_assignments.yaml b/actions/put.circuits.circuit_group_assignments.yaml index b86d0465..0581cd11 100644 --- a/actions/put.circuits.circuit_group_assignments.yaml +++ b/actions/put.circuits.circuit_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a Circuit group assignment object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. group: required: false - type: object + type: integer description: "Group" member_type: required: false diff --git a/actions/put.circuits.circuit_groups.yaml b/actions/put.circuits.circuit_groups.yaml index b7ad20af..0540386c 100644 --- a/actions/put.circuits.circuit_groups.yaml +++ b/actions/put.circuits.circuit_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a circuit group object." enabled: true entry_point: run.py @@ -34,8 +34,16 @@ parameters: description: "Description" tenant: required: false - type: object + type: integer description: "Tenant" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.circuits.circuit_terminations.yaml b/actions/put.circuits.circuit_terminations.yaml index 1735a7bd..6a220228 100644 --- a/actions/put.circuits.circuit_terminations.yaml +++ b/actions/put.circuits.circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a circuit termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. circuit: required: false - type: object + type: integer description: "Circuit" term_side: required: false diff --git a/actions/put.circuits.circuit_types.yaml b/actions/put.circuits.circuit_types.yaml index 9ff585cf..ecd47c9a 100644 --- a/actions/put.circuits.circuit_types.yaml +++ b/actions/put.circuits.circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a circuit type object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.circuits.circuits.yaml b/actions/put.circuits.circuits.yaml index d390c969..b91bc078 100644 --- a/actions/put.circuits.circuits.yaml +++ b/actions/put.circuits.circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a circuit object." enabled: true entry_point: run.py @@ -26,15 +26,15 @@ parameters: description: "Circuit ID" provider: required: false - type: object + type: integer description: "Provider" provider_account: required: false - type: object + type: integer description: "Provider account" type: required: false - type: object + type: integer description: "Type" status: required: false @@ -47,7 +47,7 @@ parameters: * `decommissioned` - Decommissioned" tenant: required: false - type: object + type: integer description: "Tenant" install_date: required: false @@ -76,6 +76,10 @@ parameters: * `m` - Meters * `mi` - Miles * `ft` - Feet" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.circuits.provider_accounts.yaml b/actions/put.circuits.provider_accounts.yaml index 46488361..d9904013 100644 --- a/actions/put.circuits.provider_accounts.yaml +++ b/actions/put.circuits.provider_accounts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a provider account object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. provider: required: false - type: object + type: integer description: "Provider" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.circuits.provider_networks.yaml b/actions/put.circuits.provider_networks.yaml index ff42a563..0120680e 100644 --- a/actions/put.circuits.provider_networks.yaml +++ b/actions/put.circuits.provider_networks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a provider network object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. provider: required: false - type: object + type: integer description: "Provider" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.circuits.providers.yaml b/actions/put.circuits.providers.yaml index 5766b7fb..0a54fc77 100644 --- a/actions/put.circuits.providers.yaml +++ b/actions/put.circuits.providers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a provider object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.circuits.virtual_circuit_terminations.yaml b/actions/put.circuits.virtual_circuit_terminations.yaml index c3cde534..cd2e6cc7 100644 --- a/actions/put.circuits.virtual_circuit_terminations.yaml +++ b/actions/put.circuits.virtual_circuit_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a virtual circuit termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_circuit: required: false - type: object + type: integer description: "Virtual circuit" role: required: false @@ -32,7 +32,7 @@ parameters: * `spoke` - Spoke" interface: required: false - type: object + type: integer description: "Interface" description: required: false diff --git a/actions/put.circuits.virtual_circuit_types.yaml b/actions/put.circuits.virtual_circuit_types.yaml index bdcf980c..520d641b 100644 --- a/actions/put.circuits.virtual_circuit_types.yaml +++ b/actions/put.circuits.virtual_circuit_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a virtual circuit type object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.circuits.virtual_circuits.yaml b/actions/put.circuits.virtual_circuits.yaml index 15ba91bd..7c506c28 100644 --- a/actions/put.circuits.virtual_circuits.yaml +++ b/actions/put.circuits.virtual_circuits.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a virtual circuit object." enabled: true entry_point: run.py @@ -26,15 +26,15 @@ parameters: description: "Circuit ID" provider_network: required: false - type: object + type: integer description: "Provider network" provider_account: required: false - type: object + type: integer description: "Provider account" type: required: false - type: object + type: integer description: "Type" status: required: false @@ -47,12 +47,16 @@ parameters: * `decommissioned` - Decommissioned" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.core.data_sources.yaml b/actions/put.core.data_sources.yaml index 0d873c61..85073350 100644 --- a/actions/put.core.data_sources.yaml +++ b/actions/put.core.data_sources.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a data source object." enabled: true entry_point: run.py @@ -56,7 +56,11 @@ parameters: ignore_rules: required: false type: string - description: "Patterns (one per line) matching files to ignore when syncing" + description: "Patterns (one per line) matching files or paths to ignore when syncing" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.cable_bundles.yaml b/actions/put.dcim.cable_bundles.yaml new file mode 100644 index 00000000..eb630de2 --- /dev/null +++ b/actions/put.dcim.cable_bundles.yaml @@ -0,0 +1,51 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Put a cable bundle object." +enabled: true +entry_point: run.py +name: put.dcim.cable_bundles +parameters: + endpoint_uri: + default: "/dcim/cable-bundles/{{ id }}/" + immutable: true + type: string + http_verb: + default: put + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" + id: + required: true + type: integer + description: "ID of the object to put." +runner_type: python-script diff --git a/actions/put.dcim.cables.yaml b/actions/put.dcim.cables.yaml index 57e54c2f..99eb2508 100644 --- a/actions/put.dcim.cables.yaml +++ b/actions/put.dcim.cables.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a cable object." enabled: true entry_point: run.py @@ -31,22 +31,31 @@ parameters: * `cat7` - CAT7 * `cat7a` - CAT7a * `cat8` - CAT8 +* `mrj21-trunk` - MRJ21 Trunk * `dac-active` - Direct Attach Copper (Active) * `dac-passive` - Direct Attach Copper (Passive) -* `mrj21-trunk` - MRJ21 Trunk * `coaxial` - Coaxial +* `rg-6` - RG-6 +* `rg-8` - RG-8 +* `rg-11` - RG-11 +* `rg-59` - RG-59 +* `rg-62` - RG-62 +* `rg-213` - RG-213 +* `lmr-100` - LMR-100 +* `lmr-200` - LMR-200 +* `lmr-400` - LMR-400 * `mmf` - Multimode Fiber * `mmf-om1` - Multimode Fiber (OM1) * `mmf-om2` - Multimode Fiber (OM2) * `mmf-om3` - Multimode Fiber (OM3) * `mmf-om4` - Multimode Fiber (OM4) * `mmf-om5` - Multimode Fiber (OM5) -* `smf` - Singlemode Fiber -* `smf-os1` - Singlemode Fiber (OS1) -* `smf-os2` - Singlemode Fiber (OS2) +* `smf` - Single-mode Fiber +* `smf-os1` - Single-mode Fiber (OS1) +* `smf-os2` - Single-mode Fiber (OS2) * `aoc` - Active Optical Cabling (AOC) -* `usb` - USB -* `power` - Power" +* `power` - Power +* `usb` - USB" a_terminations: required: false type: array @@ -61,10 +70,42 @@ parameters: description: "* `connected` - Connected * `planned` - Planned * `decommissioning` - Decommissioning" + profile: + required: false + type: string + description: "* `single-1c1p` - 1C1P +* `single-1c2p` - 1C2P +* `single-1c4p` - 1C4P +* `single-1c6p` - 1C6P +* `single-1c8p` - 1C8P +* `single-1c12p` - 1C12P +* `single-1c16p` - 1C16P +* `trunk-2c1p` - 2C1P trunk +* `trunk-2c2p` - 2C2P trunk +* `trunk-2c4p` - 2C4P trunk +* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle) +* `trunk-2c6p` - 2C6P trunk +* `trunk-2c8p` - 2C8P trunk +* `trunk-2c12p` - 2C12P trunk +* `trunk-4c1p` - 4C1P trunk +* `trunk-4c2p` - 4C2P trunk +* `trunk-4c4p` - 4C4P trunk +* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle) +* `trunk-4c6p` - 4C6P trunk +* `trunk-4c8p` - 4C8P trunk +* `trunk-8c4p` - 8C4P trunk +* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout +* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout +* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout +* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)" tenant: required: false - type: object + type: integer description: "Tenant" + bundle: + required: false + type: integer + description: "Bundle" label: required: false type: string @@ -90,6 +131,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.console_port_templates.yaml b/actions/put.dcim.console_port_templates.yaml index 517e1c58..6b5aaf61 100644 --- a/actions/put.dcim.console_port_templates.yaml +++ b/actions/put.dcim.console_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a console port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false diff --git a/actions/put.dcim.console_ports.yaml b/actions/put.dcim.console_ports.yaml index 7ea0e010..9f7aeee0 100644 --- a/actions/put.dcim.console_ports.yaml +++ b/actions/put.dcim.console_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a console port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -77,6 +77,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.console_server_port_templates.yaml b/actions/put.dcim.console_server_port_templates.yaml index 4cf9d887..3e9c08dc 100644 --- a/actions/put.dcim.console_server_port_templates.yaml +++ b/actions/put.dcim.console_server_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a console server port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false diff --git a/actions/put.dcim.console_server_ports.yaml b/actions/put.dcim.console_server_ports.yaml index f71637fb..78121ab2 100644 --- a/actions/put.dcim.console_server_ports.yaml +++ b/actions/put.dcim.console_server_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a console server port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -77,6 +77,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.device_bay_templates.yaml b/actions/put.dcim.device_bay_templates.yaml index 2ed51297..5796b5e4 100644 --- a/actions/put.dcim.device_bay_templates.yaml +++ b/actions/put.dcim.device_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a device bay template object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" name: required: false @@ -32,6 +32,10 @@ parameters: required: false type: string description: "Physical label" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string diff --git a/actions/put.dcim.device_bays.yaml b/actions/put.dcim.device_bays.yaml index f8835d14..5fa601f3 100644 --- a/actions/put.dcim.device_bays.yaml +++ b/actions/put.dcim.device_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a device bay object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" name: required: false @@ -32,14 +32,22 @@ parameters: required: false type: string description: "Physical label" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string description: "Description" installed_device: required: false - type: object + type: integer description: "Installed device" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.device_roles.yaml b/actions/put.dcim.device_roles.yaml index 91d107e2..f758e96a 100644 --- a/actions/put.dcim.device_roles.yaml +++ b/actions/put.dcim.device_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a device role object." enabled: true entry_point: run.py @@ -38,7 +38,7 @@ parameters: description: "Virtual machines may be assigned to this role" config_template: required: false - type: object + type: integer description: "Config template" parent: required: false @@ -56,6 +56,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.device_types.yaml b/actions/put.dcim.device_types.yaml index a9251f9c..0ab612a4 100644 --- a/actions/put.dcim.device_types.yaml +++ b/actions/put.dcim.device_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a device type object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. manufacturer: required: false - type: object + type: integer description: "Manufacturer" default_platform: required: false - type: object + type: integer description: "Default platform" model: required: false @@ -92,6 +92,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.devices.yaml b/actions/put.dcim.devices.yaml index 8ff07b60..e8aa5145 100644 --- a/actions/put.dcim.devices.yaml +++ b/actions/put.dcim.devices.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a device object." enabled: true entry_point: run.py @@ -26,19 +26,19 @@ parameters: description: "Name" device_type: required: false - type: object + type: integer description: "Device type" role: required: false - type: object + type: integer description: "Role" tenant: required: false - type: object + type: integer description: "Tenant" platform: required: false - type: object + type: integer description: "Platform" serial: required: false @@ -50,15 +50,15 @@ parameters: description: "A unique tag used to identify this device" site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" rack: required: false - type: object + type: integer description: "Rack" position: required: false @@ -101,23 +101,23 @@ parameters: * `mixed` - Mixed" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" oob_ip: required: false - type: object + type: integer description: "Oob ip" cluster: required: false - type: object + type: integer description: "Cluster" virtual_chassis: required: false - type: object + type: integer description: "Virtual chassis" vc_position: required: false @@ -131,13 +131,17 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" config_template: required: false - type: object + type: integer description: "Config template" local_context_data: required: false diff --git a/actions/put.dcim.front_port_templates.yaml b/actions/put.dcim.front_port_templates.yaml index a48b34b6..d18e643c 100644 --- a/actions/put.dcim.front_port_templates.yaml +++ b/actions/put.dcim.front_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a front port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -101,14 +101,14 @@ parameters: required: false type: string description: "Color" - rear_port: - required: false - type: object - description: "Rear port" - rear_port_position: + positions: required: false type: integer - description: "Rear port position" + description: "Positions" + rear_ports: + required: false + type: array + description: "Rear ports" description: required: false type: string diff --git a/actions/put.dcim.front_ports.yaml b/actions/put.dcim.front_ports.yaml index d0d2e0e6..7da3639b 100644 --- a/actions/put.dcim.front_ports.yaml +++ b/actions/put.dcim.front_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a front port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -101,14 +101,14 @@ parameters: required: false type: string description: "Color" - rear_port: + positions: required: false type: integer - description: "Rear port" - rear_port_position: + description: "Positions" + rear_ports: required: false - type: integer - description: "Mapped position on corresponding rear port" + type: array + description: "Rear ports" description: required: false type: string @@ -117,6 +117,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.interface_templates.yaml b/actions/put.dcim.interface_templates.yaml index e65dda35..50659eea 100644 --- a/actions/put.dcim.interface_templates.yaml +++ b/actions/put.dcim.interface_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a interface template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -42,50 +42,133 @@ parameters: description: "* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) -* `100base-fx` - 100BASE-FX (10/100ME FIBER) -* `100base-lfx` - 100BASE-LFX (10/100ME FIBER) +* `100base-fx` - 100BASE-FX (10/100ME) +* `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) -* `100base-t1` - 100BASE-T1 (10/100ME Single Pair) -* `1000base-t` - 1000BASE-T (1GE) -* `1000base-sx` - 1000BASE-SX (1GE) +* `100base-t1` - 100BASE-T1 (10/100ME) +* `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) +* `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) +* `1000base-cwdm` - 1000BASE-CWDM (1GE) +* `1000base-cx` - 1000BASE-CX (1GE DAC) +* `1000base-dwdm` - 1000BASE-DWDM (1GE) +* `1000base-ex` - 1000BASE-EX (1GE) +* `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) +* `1000base-lx10` - 1000BASE-LX10/LH (1GE) +* `1000base-sx` - 1000BASE-SX (1GE) +* `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) +* `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) +* `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) +* `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) +* `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) +* `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) +* `10gbase-er` - 10GBASE-ER (10GE) +* `10gbase-lr` - 10GBASE-LR (10GE) +* `10gbase-lrm` - 10GBASE-LRM (10GE) +* `10gbase-lx4` - 10GBASE-LX4 (10GE) +* `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) -* `10gbase-cx4` - 10GBASE-CX4 (10GE) +* `10gbase-zr` - 10GBASE-ZR (10GE) +* `25gbase-cr` - 25GBASE-CR (25GE DAC) +* `25gbase-er` - 25GBASE-ER (25GE) +* `25gbase-lr` - 25GBASE-LR (25GE) +* `25gbase-sr` - 25GBASE-SR (25GE) +* `25gbase-t` - 25GBASE-T (25GE) +* `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) +* `40gbase-er4` - 40GBASE-ER4 (40GE) +* `40gbase-fr4` - 40GBASE-FR4 (40GE) +* `40gbase-lr4` - 40GBASE-LR4 (40GE) +* `40gbase-sr4` - 40GBASE-SR4 (40GE) +* `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) +* `50gbase-cr` - 50GBASE-CR (50GE DAC) +* `50gbase-er` - 50GBASE-ER (50GE) +* `50gbase-fr` - 50GBASE-FR (50GE) +* `50gbase-lr` - 50GBASE-LR (50GE) +* `50gbase-sr` - 50GBASE-SR (50GE) +* `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) +* `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) +* `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) +* `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) +* `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) +* `100gbase-dr` - 100GBASE-DR (100GE) +* `100gbase-er4` - 100GBASE-ER4 (100GE) +* `100gbase-fr1` - 100GBASE-FR1 (100GE) +* `100gbase-lr1` - 100GBASE-LR1 (100GE) +* `100gbase-lr4` - 100GBASE-LR4 (100GE) +* `100gbase-sr1` - 100GBASE-SR1 (100GE) +* `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) +* `100gbase-sr2` - 100GBASE-SR2 (100GE) +* `100gbase-sr4` - 100GBASE-SR4 (100GE) +* `100gbase-sr10` - 100GBASE-SR10 (100GE) +* `100gbase-zr` - 100GBASE-ZR (100GE) +* `200gbase-cr2` - 200GBASE-CR2 (200GE) +* `200gbase-cr4` - 200GBASE-CR4 (200GE) +* `200gbase-dr4` - 200GBASE-DR4 (200GE) +* `200gbase-er4` - 200GBASE-ER4 (200GE) +* `200gbase-fr4` - 200GBASE-FR4 (200GE) +* `200gbase-lr4` - 200GBASE-LR4 (200GE) +* `200gbase-sr2` - 200GBASE-SR2 (200GE) +* `200gbase-sr4` - 200GBASE-SR4 (200GE) +* `200gbase-vr2` - 200GBASE-VR2 (200GE) +* `400gbase-cr4` - 400GBASE-CR4 (400GE) +* `400gbase-dr4` - 400GBASE-DR4 (400GE) +* `400gbase-er8` - 400GBASE-ER8 (400GE) +* `400gbase-fr4` - 400GBASE-FR4 (400GE) +* `400gbase-fr8` - 400GBASE-FR8 (400GE) +* `400gbase-lr4` - 400GBASE-LR4 (400GE) +* `400gbase-lr8` - 400GBASE-LR8 (400GE) +* `400gbase-sr4` - 400GBASE-SR4 (400GE) +* `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) +* `400gbase-sr8` - 400GBASE-SR8 (400GE) +* `400gbase-sr16` - 400GBASE-SR16 (400GE) +* `400gbase-vr4` - 400GBASE-VR4 (400GE) +* `400gbase-zr` - 400GBASE-ZR (400GE) +* `800gbase-cr8` - 800GBASE-CR8 (800GE) +* `800gbase-dr8` - 800GBASE-DR8 (800GE) +* `800gbase-sr8` - 800GBASE-SR8 (800GE) +* `800gbase-vr8` - 800GBASE-VR8 (800GE) +* `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) +* `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) +* `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) +* `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) -* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) +* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) -* `50gbase-x-sfp56` - SFP56 (50GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) +* `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) -* `200gbase-x-cfp2` - CFP2 (200GE) -* `400gbase-x-cfp2` - CFP2 (400GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) -* `100gbase-x-sfpdd` - SFP-DD (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) +* `100gbase-x-sfpdd` - SFP-DD (100GE) +* `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) -* `400gbase-x-osfp` - OSFP (400GE) -* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `400gbase-x-cdfp` - CDFP (400GE) +* `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) -* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `400gbase-x-osfp` - OSFP (400GE) +* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) +* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) +* `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) +* `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) @@ -97,14 +180,15 @@ parameters: * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) +* `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g -* `ieee802.11n` - IEEE 802.11n -* `ieee802.11ac` - IEEE 802.11ac -* `ieee802.11ad` - IEEE 802.11ad -* `ieee802.11ax` - IEEE 802.11ax -* `ieee802.11ay` - IEEE 802.11ay -* `ieee802.11be` - IEEE 802.11be +* `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) +* `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) +* `ieee802.11ad` - IEEE 802.11ad (WiGig) +* `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) +* `ieee802.11ay` - IEEE 802.11ay (WiGig) +* `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) diff --git a/actions/put.dcim.interfaces.yaml b/actions/put.dcim.interfaces.yaml index 6d247f21..38cee0e0 100644 --- a/actions/put.dcim.interfaces.yaml +++ b/actions/put.dcim.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a interface object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" vdcs: required: false @@ -30,7 +30,7 @@ parameters: description: "Vdcs" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -46,50 +46,133 @@ parameters: description: "* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) -* `100base-fx` - 100BASE-FX (10/100ME FIBER) -* `100base-lfx` - 100BASE-LFX (10/100ME FIBER) +* `100base-fx` - 100BASE-FX (10/100ME) +* `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) -* `100base-t1` - 100BASE-T1 (10/100ME Single Pair) -* `1000base-t` - 1000BASE-T (1GE) -* `1000base-sx` - 1000BASE-SX (1GE) +* `100base-t1` - 100BASE-T1 (10/100ME) +* `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) +* `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) +* `1000base-cwdm` - 1000BASE-CWDM (1GE) +* `1000base-cx` - 1000BASE-CX (1GE DAC) +* `1000base-dwdm` - 1000BASE-DWDM (1GE) +* `1000base-ex` - 1000BASE-EX (1GE) +* `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) +* `1000base-lx10` - 1000BASE-LX10/LH (1GE) +* `1000base-sx` - 1000BASE-SX (1GE) +* `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) +* `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) +* `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) +* `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) +* `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) +* `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) +* `10gbase-er` - 10GBASE-ER (10GE) +* `10gbase-lr` - 10GBASE-LR (10GE) +* `10gbase-lrm` - 10GBASE-LRM (10GE) +* `10gbase-lx4` - 10GBASE-LX4 (10GE) +* `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) -* `10gbase-cx4` - 10GBASE-CX4 (10GE) +* `10gbase-zr` - 10GBASE-ZR (10GE) +* `25gbase-cr` - 25GBASE-CR (25GE DAC) +* `25gbase-er` - 25GBASE-ER (25GE) +* `25gbase-lr` - 25GBASE-LR (25GE) +* `25gbase-sr` - 25GBASE-SR (25GE) +* `25gbase-t` - 25GBASE-T (25GE) +* `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) +* `40gbase-er4` - 40GBASE-ER4 (40GE) +* `40gbase-fr4` - 40GBASE-FR4 (40GE) +* `40gbase-lr4` - 40GBASE-LR4 (40GE) +* `40gbase-sr4` - 40GBASE-SR4 (40GE) +* `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) +* `50gbase-cr` - 50GBASE-CR (50GE DAC) +* `50gbase-er` - 50GBASE-ER (50GE) +* `50gbase-fr` - 50GBASE-FR (50GE) +* `50gbase-lr` - 50GBASE-LR (50GE) +* `50gbase-sr` - 50GBASE-SR (50GE) +* `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) +* `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) +* `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) +* `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) +* `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) +* `100gbase-dr` - 100GBASE-DR (100GE) +* `100gbase-er4` - 100GBASE-ER4 (100GE) +* `100gbase-fr1` - 100GBASE-FR1 (100GE) +* `100gbase-lr1` - 100GBASE-LR1 (100GE) +* `100gbase-lr4` - 100GBASE-LR4 (100GE) +* `100gbase-sr1` - 100GBASE-SR1 (100GE) +* `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) +* `100gbase-sr2` - 100GBASE-SR2 (100GE) +* `100gbase-sr4` - 100GBASE-SR4 (100GE) +* `100gbase-sr10` - 100GBASE-SR10 (100GE) +* `100gbase-zr` - 100GBASE-ZR (100GE) +* `200gbase-cr2` - 200GBASE-CR2 (200GE) +* `200gbase-cr4` - 200GBASE-CR4 (200GE) +* `200gbase-dr4` - 200GBASE-DR4 (200GE) +* `200gbase-er4` - 200GBASE-ER4 (200GE) +* `200gbase-fr4` - 200GBASE-FR4 (200GE) +* `200gbase-lr4` - 200GBASE-LR4 (200GE) +* `200gbase-sr2` - 200GBASE-SR2 (200GE) +* `200gbase-sr4` - 200GBASE-SR4 (200GE) +* `200gbase-vr2` - 200GBASE-VR2 (200GE) +* `400gbase-cr4` - 400GBASE-CR4 (400GE) +* `400gbase-dr4` - 400GBASE-DR4 (400GE) +* `400gbase-er8` - 400GBASE-ER8 (400GE) +* `400gbase-fr4` - 400GBASE-FR4 (400GE) +* `400gbase-fr8` - 400GBASE-FR8 (400GE) +* `400gbase-lr4` - 400GBASE-LR4 (400GE) +* `400gbase-lr8` - 400GBASE-LR8 (400GE) +* `400gbase-sr4` - 400GBASE-SR4 (400GE) +* `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) +* `400gbase-sr8` - 400GBASE-SR8 (400GE) +* `400gbase-sr16` - 400GBASE-SR16 (400GE) +* `400gbase-vr4` - 400GBASE-VR4 (400GE) +* `400gbase-zr` - 400GBASE-ZR (400GE) +* `800gbase-cr8` - 800GBASE-CR8 (800GE) +* `800gbase-dr8` - 800GBASE-DR8 (800GE) +* `800gbase-sr8` - 800GBASE-SR8 (800GE) +* `800gbase-vr8` - 800GBASE-VR8 (800GE) +* `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) +* `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) +* `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) +* `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) -* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) +* `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) -* `50gbase-x-sfp56` - SFP56 (50GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) +* `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) -* `200gbase-x-cfp2` - CFP2 (200GE) -* `400gbase-x-cfp2` - CFP2 (400GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) -* `100gbase-x-sfpdd` - SFP-DD (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) +* `100gbase-x-sfpdd` - SFP-DD (100GE) +* `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) -* `400gbase-x-osfp` - OSFP (400GE) -* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `400gbase-x-cdfp` - CDFP (400GE) +* `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) -* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `400gbase-x-osfp` - OSFP (400GE) +* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) +* `800gbase-x-qsfpdd` - QSFP-DD (800GE) +* `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) +* `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) +* `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) @@ -101,14 +184,15 @@ parameters: * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) +* `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g -* `ieee802.11n` - IEEE 802.11n -* `ieee802.11ac` - IEEE 802.11ac -* `ieee802.11ad` - IEEE 802.11ad -* `ieee802.11ax` - IEEE 802.11ax -* `ieee802.11ay` - IEEE 802.11ay -* `ieee802.11be` - IEEE 802.11be +* `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) +* `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) +* `ieee802.11ad` - IEEE 802.11ad (WiGig) +* `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) +* `ieee802.11ay` - IEEE 802.11ay (WiGig) +* `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) @@ -197,7 +281,7 @@ parameters: description: "Mtu" primary_mac_address: required: false - type: object + type: integer description: "Primary mac address" speed: required: false @@ -268,7 +352,7 @@ parameters: description: "Transmit power (dBm)" untagged_vlan: required: false - type: object + type: integer description: "Untagged vlan" tagged_vlans: required: false @@ -276,11 +360,11 @@ parameters: description: "Tagged vlans" qinq_svlan: required: false - type: object + type: integer description: "Qinq svlan" vlan_translation_policy: required: false - type: object + type: integer description: "Vlan translation policy" mark_connected: required: false @@ -292,8 +376,12 @@ parameters: description: "Wireless lans" vrf: required: false - type: object + type: integer description: "Vrf" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.inventory_item_roles.yaml b/actions/put.dcim.inventory_item_roles.yaml index 6faa7acb..da0ef711 100644 --- a/actions/put.dcim.inventory_item_roles.yaml +++ b/actions/put.dcim.inventory_item_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a inventory item role object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.dcim.inventory_item_templates.yaml b/actions/put.dcim.inventory_item_templates.yaml index c1afa61a..e93114aa 100644 --- a/actions/put.dcim.inventory_item_templates.yaml +++ b/actions/put.dcim.inventory_item_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a inventory item template object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" parent: required: false @@ -38,11 +38,11 @@ parameters: description: "Physical label" role: required: false - type: object + type: integer description: "Role" manufacturer: required: false - type: object + type: integer description: "Manufacturer" part_id: required: false diff --git a/actions/put.dcim.inventory_items.yaml b/actions/put.dcim.inventory_items.yaml index 47a616e2..6ff08a67 100644 --- a/actions/put.dcim.inventory_items.yaml +++ b/actions/put.dcim.inventory_items.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a inventory item object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" parent: required: false @@ -47,11 +47,11 @@ parameters: * `decommissioning` - Decommissioning" role: required: false - type: object + type: integer description: "Role" manufacturer: required: false - type: object + type: integer description: "Manufacturer" part_id: required: false @@ -81,6 +81,10 @@ parameters: required: false type: integer description: "Component id" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.locations.yaml b/actions/put.dcim.locations.yaml index 796ca3e4..9fab59ff 100644 --- a/actions/put.dcim.locations.yaml +++ b/actions/put.dcim.locations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a location object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Slug" site: required: false - type: object + type: integer description: "Site" parent: required: false @@ -46,7 +46,7 @@ parameters: * `retired` - Retired" tenant: required: false - type: object + type: integer description: "Tenant" facility: required: false @@ -64,6 +64,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.mac_addresses.yaml b/actions/put.dcim.mac_addresses.yaml index ae326247..e9724353 100644 --- a/actions/put.dcim.mac_addresses.yaml +++ b/actions/put.dcim.mac_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a MAC address object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.manufacturers.yaml b/actions/put.dcim.manufacturers.yaml index cf0aa26b..d96795d5 100644 --- a/actions/put.dcim.manufacturers.yaml +++ b/actions/put.dcim.manufacturers.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a manufacturer object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.dcim.module_bay_templates.yaml b/actions/put.dcim.module_bay_templates.yaml index 2cea7852..2bfc0eb2 100644 --- a/actions/put.dcim.module_bay_templates.yaml +++ b/actions/put.dcim.module_bay_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a module bay template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Identifier to reference when renaming installed components" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string diff --git a/actions/put.dcim.module_bays.yaml b/actions/put.dcim.module_bays.yaml index f95a6dcc..26f24bf5 100644 --- a/actions/put.dcim.module_bays.yaml +++ b/actions/put.dcim.module_bays.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a module bay object." enabled: true entry_point: run.py @@ -22,20 +22,16 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false type: string description: "Name" - installed_module: - required: false - type: object - description: "Installed module" label: required: false type: string @@ -44,10 +40,22 @@ parameters: required: false type: string description: "Identifier to reference when renaming installed components" + enabled: + required: false + type: boolean + description: "Enabled" description: required: false type: string description: "Description" + installed_module: + required: false + type: integer + description: "Installed module" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.module_type_profiles.yaml b/actions/put.dcim.module_type_profiles.yaml index 3f28fb4a..f7dcb8bb 100644 --- a/actions/put.dcim.module_type_profiles.yaml +++ b/actions/put.dcim.module_type_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a module type profile object." enabled: true entry_point: run.py @@ -32,6 +32,10 @@ parameters: required: false type: object description: "Schema" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.module_types.yaml b/actions/put.dcim.module_types.yaml index fb4bc8a4..d3f99e29 100644 --- a/actions/put.dcim.module_types.yaml +++ b/actions/put.dcim.module_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a module type object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. profile: required: false - type: object + type: integer description: "Profile" manufacturer: required: false - type: object + type: integer description: "Manufacturer" model: required: false @@ -64,6 +64,10 @@ parameters: required: false type: object description: "Attributes" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.modules.yaml b/actions/put.dcim.modules.yaml index 2c8fe3fd..e3d71e11 100644 --- a/actions/put.dcim.modules.yaml +++ b/actions/put.dcim.modules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a module object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module_bay: required: false @@ -30,7 +30,7 @@ parameters: description: "Module bay" module_type: required: false - type: object + type: integer description: "Module type" status: required: false @@ -53,6 +53,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -65,6 +69,14 @@ parameters: required: false type: object description: "Custom fields" + replicate_components: + required: false + type: boolean + description: "Automatically populate components associated with this module type (default: true)" + adopt_components: + required: false + type: boolean + description: "Adopt already existing components" id: required: true type: integer diff --git a/actions/put.dcim.platforms.yaml b/actions/put.dcim.platforms.yaml index 4e97f704..9a14eb2f 100644 --- a/actions/put.dcim.platforms.yaml +++ b/actions/put.dcim.platforms.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a platform object." enabled: true entry_point: run.py @@ -20,6 +20,10 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + parent: + required: false + type: integer + description: "Parent" name: required: false type: string @@ -30,16 +34,24 @@ parameters: description: "Slug" manufacturer: required: false - type: object + type: integer description: "Manufacturer" config_template: required: false - type: object + type: integer description: "Config template" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.dcim.power_feeds.yaml b/actions/put.dcim.power_feeds.yaml index 073f9991..a09128aa 100644 --- a/actions/put.dcim.power_feeds.yaml +++ b/actions/put.dcim.power_feeds.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a power feed object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. power_panel: required: false - type: object + type: integer description: "Power panel" rack: required: false - type: object + type: integer description: "Rack" name: required: false @@ -76,8 +76,12 @@ parameters: description: "Description" tenant: required: false - type: object + type: integer description: "Tenant" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.power_outlet_templates.yaml b/actions/put.dcim.power_outlet_templates.yaml index ab90ec2e..9957dd9f 100644 --- a/actions/put.dcim.power_outlet_templates.yaml +++ b/actions/put.dcim.power_outlet_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a power outlet template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -43,6 +43,7 @@ parameters: * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 +* `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -125,6 +126,7 @@ parameters: * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 @@ -137,9 +139,13 @@ parameters: * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other" + color: + required: false + type: string + description: "Color" power_port: required: false - type: object + type: integer description: "Power port" feed_leg: required: false diff --git a/actions/put.dcim.power_outlets.yaml b/actions/put.dcim.power_outlets.yaml index 8a0b4db7..0207905f 100644 --- a/actions/put.dcim.power_outlets.yaml +++ b/actions/put.dcim.power_outlets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a power outlet object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -45,6 +45,7 @@ parameters: * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 +* `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -127,6 +128,7 @@ parameters: * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 @@ -151,7 +153,7 @@ parameters: description: "Color" power_port: required: false - type: object + type: integer description: "Power port" feed_leg: required: false @@ -169,6 +171,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.power_panels.yaml b/actions/put.dcim.power_panels.yaml index 858cf204..bdeade65 100644 --- a/actions/put.dcim.power_panels.yaml +++ b/actions/put.dcim.power_panels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a power panel object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" name: required: false @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.power_port_templates.yaml b/actions/put.dcim.power_port_templates.yaml index 666ccfb2..e3d1adbd 100644 --- a/actions/put.dcim.power_port_templates.yaml +++ b/actions/put.dcim.power_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a power port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -43,6 +43,7 @@ parameters: * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 +* `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -133,6 +134,7 @@ parameters: * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid diff --git a/actions/put.dcim.power_ports.yaml b/actions/put.dcim.power_ports.yaml index c8948530..4f86b719 100644 --- a/actions/put.dcim.power_ports.yaml +++ b/actions/put.dcim.power_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a power port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -45,6 +45,7 @@ parameters: * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 +* `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H @@ -135,6 +136,7 @@ parameters: * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 +* `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid @@ -161,6 +163,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.rack_groups.yaml b/actions/put.dcim.rack_groups.yaml new file mode 100644 index 00000000..8666ae1e --- /dev/null +++ b/actions/put.dcim.rack_groups.yaml @@ -0,0 +1,55 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Put a rack group object." +enabled: true +entry_point: run.py +name: put.dcim.rack_groups +parameters: + endpoint_uri: + default: "/dcim/rack-groups/{{ id }}/" + immutable: true + type: string + http_verb: + default: put + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + slug: + required: false + type: string + description: "Slug" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" + id: + required: true + type: integer + description: "ID of the object to put." +runner_type: python-script diff --git a/actions/put.dcim.rack_reservations.yaml b/actions/put.dcim.rack_reservations.yaml index c74807f3..ffb92d6a 100644 --- a/actions/put.dcim.rack_reservations.yaml +++ b/actions/put.dcim.rack_reservations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a rack reservation object." enabled: true entry_point: run.py @@ -22,24 +22,34 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. rack: required: false - type: object + type: integer description: "Rack" units: required: false type: array description: "Units" + status: + required: false + type: string + description: "* `pending` - Pending +* `active` - Active +* `stale` - Stale" user: required: false - type: object + type: integer description: "User" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.rack_roles.yaml b/actions/put.dcim.rack_roles.yaml index 6db9e4cd..66f4460c 100644 --- a/actions/put.dcim.rack_roles.yaml +++ b/actions/put.dcim.rack_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a rack role object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.dcim.rack_types.yaml b/actions/put.dcim.rack_types.yaml index 534cef85..70d90bb8 100644 --- a/actions/put.dcim.rack_types.yaml +++ b/actions/put.dcim.rack_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a rack type object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. manufacturer: required: false - type: object + type: integer description: "Manufacturer" model: required: false @@ -103,6 +103,10 @@ parameters: required: false type: integer description: "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails." + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.racks.yaml b/actions/put.dcim.racks.yaml index 023542e6..d6755fd8 100644 --- a/actions/put.dcim.racks.yaml +++ b/actions/put.dcim.racks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a rack object." enabled: true entry_point: run.py @@ -30,15 +30,19 @@ parameters: description: "Facility id" site: required: false - type: object + type: integer description: "Site" location: required: false - type: object + type: integer description: "Location" + group: + required: false + type: integer + description: "Group" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -50,7 +54,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" serial: required: false @@ -62,7 +66,7 @@ parameters: description: "A unique tag used to identify this rack" rack_type: required: false - type: object + type: integer description: "Rack type" form_factor: required: false @@ -140,6 +144,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.rear_port_templates.yaml b/actions/put.dcim.rear_port_templates.yaml index 55ba392c..374fa965 100644 --- a/actions/put.dcim.rear_port_templates.yaml +++ b/actions/put.dcim.rear_port_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a rear port template object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device_type: required: false - type: object + type: integer description: "Device type" module_type: required: false - type: object + type: integer description: "Module type" name: required: false @@ -105,6 +105,10 @@ parameters: required: false type: integer description: "Positions" + front_ports: + required: false + type: array + description: "Front ports" description: required: false type: string diff --git a/actions/put.dcim.rear_ports.yaml b/actions/put.dcim.rear_ports.yaml index 8528a881..b2b83ff2 100644 --- a/actions/put.dcim.rear_ports.yaml +++ b/actions/put.dcim.rear_ports.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a rear port object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. device: required: false - type: object + type: integer description: "Device" module: required: false - type: object + type: integer description: "Module" name: required: false @@ -104,7 +104,11 @@ parameters: positions: required: false type: integer - description: "Number of front ports which may be mapped" + description: "Positions" + front_ports: + required: false + type: array + description: "Front ports" description: required: false type: string @@ -113,6 +117,10 @@ parameters: required: false type: boolean description: "Treat as if a cable is connected" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.dcim.regions.yaml b/actions/put.dcim.regions.yaml index ebe09865..a82dfaab 100644 --- a/actions/put.dcim.regions.yaml +++ b/actions/put.dcim.regions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a region object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.site_groups.yaml b/actions/put.dcim.site_groups.yaml index 5fc45cde..7d85ff18 100644 --- a/actions/put.dcim.site_groups.yaml +++ b/actions/put.dcim.site_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a site group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.sites.yaml b/actions/put.dcim.sites.yaml index 99808e64..d64a126e 100644 --- a/actions/put.dcim.sites.yaml +++ b/actions/put.dcim.sites.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a site object." enabled: true entry_point: run.py @@ -38,15 +38,15 @@ parameters: * `retired` - Retired" region: required: false - type: object + type: integer description: "Region" group: required: false - type: object + type: integer description: "Group" tenant: required: false - type: object + type: integer description: "Tenant" facility: required: false @@ -76,6 +76,10 @@ parameters: required: false type: integer description: "GPS coordinate in decimal format (xx.yyyyyy)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.virtual_chassis.yaml b/actions/put.dcim.virtual_chassis.yaml index 89bdb3f3..17758b88 100644 --- a/actions/put.dcim.virtual_chassis.yaml +++ b/actions/put.dcim.virtual_chassis.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a virtual chassis object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.dcim.virtual_device_contexts.yaml b/actions/put.dcim.virtual_device_contexts.yaml index 2eac071b..9e534339 100644 --- a/actions/put.dcim.virtual_device_contexts.yaml +++ b/actions/put.dcim.virtual_device_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a virtual device context object." enabled: true entry_point: run.py @@ -26,7 +26,7 @@ parameters: description: "Name" device: required: false - type: object + type: integer description: "Device" identifier: required: false @@ -34,15 +34,15 @@ parameters: description: "Identifier" tenant: required: false - type: object + type: integer description: "Tenant" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" status: required: false @@ -54,6 +54,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.extras.bookmarks.yaml b/actions/put.extras.bookmarks.yaml index 28329438..cb248d49 100644 --- a/actions/put.extras.bookmarks.yaml +++ b/actions/put.extras.bookmarks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a bookmark object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" id: required: true diff --git a/actions/put.extras.config_context_profiles.yaml b/actions/put.extras.config_context_profiles.yaml new file mode 100644 index 00000000..22f289fd --- /dev/null +++ b/actions/put.extras.config_context_profiles.yaml @@ -0,0 +1,55 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Put a config context profile object." +enabled: true +entry_point: run.py +name: put.extras.config_context_profiles +parameters: + endpoint_uri: + default: "/extras/config-context-profiles/{{ id }}/" + immutable: true + type: string + http_verb: + default: put + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + schema: + required: false + type: object + description: "A JSON schema specifying the structure of the context data for this profile" + tags: + required: false + type: array + description: "Array of tag strings" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + data_source: + required: false + type: integer + description: "Data source" + id: + required: true + type: integer + description: "ID of the object to put." +runner_type: python-script diff --git a/actions/put.extras.config_contexts.yaml b/actions/put.extras.config_contexts.yaml index 9c2c5aa5..40cdeaf1 100644 --- a/actions/put.extras.config_contexts.yaml +++ b/actions/put.extras.config_contexts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a config context object." enabled: true entry_point: run.py @@ -28,6 +28,10 @@ parameters: required: false type: integer description: "Weight" + profile: + required: false + type: integer + description: "Profile" description: required: false type: string @@ -84,13 +88,17 @@ parameters: required: false type: array description: "Tenants" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array description: "Array of tag strings" data_source: required: false - type: object + type: integer description: "Data source" data: required: false diff --git a/actions/put.extras.config_templates.yaml b/actions/put.extras.config_templates.yaml index 4f211d83..1c6c937e 100644 --- a/actions/put.extras.config_templates.yaml +++ b/actions/put.extras.config_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a config template object." enabled: true entry_point: run.py @@ -52,10 +52,22 @@ parameters: required: false type: boolean description: "Download file as attachment" + debug: + required: false + type: boolean + description: "Enable verbose error output when rendering this template. Not recommended for production use." data_source: required: false - type: object + type: integer description: "Data source" + auto_sync_enabled: + required: false + type: boolean + description: "Enable automatic synchronization of data when the data file is updated" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.extras.custom_field_choice_sets.yaml b/actions/put.extras.custom_field_choice_sets.yaml index cbe4d2d0..82e93813 100644 --- a/actions/put.extras.custom_field_choice_sets.yaml +++ b/actions/put.extras.custom_field_choice_sets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a custom field choice set object." enabled: true entry_point: run.py @@ -40,10 +40,18 @@ parameters: required: false type: array description: "Extra choices" + choice_colors: + required: false + type: object + description: "Choice colors" order_alphabetically: required: false type: boolean description: "Choices are automatically ordered alphabetically" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/put.extras.custom_fields.yaml b/actions/put.extras.custom_fields.yaml index 02c04691..75c196a2 100644 --- a/actions/put.extras.custom_fields.yaml +++ b/actions/put.extras.custom_fields.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a custom field object." enabled: true entry_point: run.py @@ -126,10 +126,18 @@ parameters: required: false type: string description: "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, <code>^[A-Z]{3}$</code> will limit values to exactly three uppercase letters." - choice_set: + validation_schema: required: false type: object + description: "A JSON schema definition for validating the custom field value" + choice_set: + required: false + type: integer description: "Choice set" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.extras.custom_links.yaml b/actions/put.extras.custom_links.yaml index fe122d15..641a5c64 100644 --- a/actions/put.extras.custom_links.yaml +++ b/actions/put.extras.custom_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a custom link object." enabled: true entry_point: run.py @@ -72,6 +72,10 @@ parameters: required: false type: boolean description: "Force link to open in a new window" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/put.extras.dashboard.yaml b/actions/put.extras.dashboard.yaml index 0d4458e2..4bdd4ed5 100644 --- a/actions/put.extras.dashboard.yaml +++ b/actions/put.extras.dashboard.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a list of dashboard objects." enabled: true entry_point: run.py diff --git a/actions/put.extras.event_rules.yaml b/actions/put.extras.event_rules.yaml index 7f3b89a8..cb1e7566 100644 --- a/actions/put.extras.event_rules.yaml +++ b/actions/put.extras.event_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a event rule object." enabled: true entry_point: run.py @@ -62,6 +62,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.extras.export_templates.yaml b/actions/put.extras.export_templates.yaml index 94d3d370..01f704e8 100644 --- a/actions/put.extras.export_templates.yaml +++ b/actions/put.extras.export_templates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a export template object." enabled: true entry_point: run.py @@ -58,8 +58,12 @@ parameters: description: "Download file as attachment" data_source: required: false - type: object + type: integer description: "Data source" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/put.extras.image_attachments.yaml b/actions/put.extras.image_attachments.yaml index 914ef0ca..fc1dc5a8 100644 --- a/actions/put.extras.image_attachments.yaml +++ b/actions/put.extras.image_attachments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a image attachment object." enabled: true entry_point: run.py @@ -36,6 +36,10 @@ parameters: required: false type: string description: "Image" + description: + required: false + type: string + description: "Description" id: required: true type: integer diff --git a/actions/put.extras.journal_entries.yaml b/actions/put.extras.journal_entries.yaml index 9bdf6a44..4588bf85 100644 --- a/actions/put.extras.journal_entries.yaml +++ b/actions/put.extras.journal_entries.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a journal entry object." enabled: true entry_point: run.py diff --git a/actions/put.extras.notification_groups.yaml b/actions/put.extras.notification_groups.yaml index e83a9bf4..07c57378 100644 --- a/actions/put.extras.notification_groups.yaml +++ b/actions/put.extras.notification_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a notification group object." enabled: true entry_point: run.py diff --git a/actions/put.extras.notifications.yaml b/actions/put.extras.notifications.yaml index 84fef0b6..00d01212 100644 --- a/actions/put.extras.notifications.yaml +++ b/actions/put.extras.notifications.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a notification object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" read: required: false diff --git a/actions/put.extras.saved_filters.yaml b/actions/put.extras.saved_filters.yaml index 70826422..25c906a2 100644 --- a/actions/put.extras.saved_filters.yaml +++ b/actions/put.extras.saved_filters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a saved filter object." enabled: true entry_point: run.py @@ -56,6 +56,10 @@ parameters: required: false type: object description: "Parameters" + owner: + required: false + type: integer + description: "Owner" id: required: true type: integer diff --git a/actions/put.extras.scripts.yaml b/actions/put.extras.scripts.yaml index d6076ef3..7f3be3ee 100644 --- a/actions/put.extras.scripts.yaml +++ b/actions/put.extras.scripts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a script object." enabled: true entry_point: run.py @@ -36,6 +36,12 @@ parameters: required: false type: integer description: "Interval" + notifications: + required: false + type: string + description: "* `always` - Always +* `on_failure` - On failure +* `never` - Never" id: required: true type: integer diff --git a/actions/put.extras.subscriptions.yaml b/actions/put.extras.subscriptions.yaml index 88c96532..3662385a 100644 --- a/actions/put.extras.subscriptions.yaml +++ b/actions/put.extras.subscriptions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a subscription object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Object id" user: required: false - type: object + type: integer description: "User" id: required: true diff --git a/actions/put.extras.table_configs.yaml b/actions/put.extras.table_configs.yaml index 705f0f76..3e8240d6 100644 --- a/actions/put.extras.table_configs.yaml +++ b/actions/put.extras.table_configs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a table config object." enabled: true entry_point: run.py diff --git a/actions/put.extras.tags.yaml b/actions/put.extras.tags.yaml index 7f92528f..838d6cbd 100644 --- a/actions/put.extras.tags.yaml +++ b/actions/put.extras.tags.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a tag object." enabled: true entry_point: run.py diff --git a/actions/put.extras.webhooks.yaml b/actions/put.extras.webhooks.yaml index 2724fd15..46918d47 100644 --- a/actions/put.extras.webhooks.yaml +++ b/actions/put.extras.webhooks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a webhook object." enabled: true entry_point: run.py @@ -68,6 +68,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.ipam.aggregates.yaml b/actions/put.ipam.aggregates.yaml index b743749b..0605afac 100644 --- a/actions/put.ipam.aggregates.yaml +++ b/actions/put.ipam.aggregates.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a aggregate object." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Prefix" rir: required: false - type: object + type: integer description: "Rir" tenant: required: false - type: object + type: integer description: "Tenant" date_added: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.asn_ranges.yaml b/actions/put.ipam.asn_ranges.yaml index 7b2446f6..7bba9351 100644 --- a/actions/put.ipam.asn_ranges.yaml +++ b/actions/put.ipam.asn_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a ASN range object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Slug" rir: required: false - type: object + type: integer description: "Rir" start: required: false @@ -42,12 +42,20 @@ parameters: description: "End" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.ipam.asns.yaml b/actions/put.ipam.asns.yaml index 8cced53b..fd060c8b 100644 --- a/actions/put.ipam.asns.yaml +++ b/actions/put.ipam.asns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a ASN object." enabled: true entry_point: run.py @@ -26,16 +26,24 @@ parameters: description: "16- or 32-bit autonomous system number" rir: required: false - type: object + type: integer description: "Rir" + role: + required: false + type: integer + description: "Role" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -48,6 +56,10 @@ parameters: required: false type: object description: "Custom fields" + sites: + required: false + type: array + description: "Sites" id: required: true type: integer diff --git a/actions/put.ipam.fhrp_group_assignments.yaml b/actions/put.ipam.fhrp_group_assignments.yaml index e92deaa7..81c5a4e6 100644 --- a/actions/put.ipam.fhrp_group_assignments.yaml +++ b/actions/put.ipam.fhrp_group_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a FHRP group assignment object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. group: required: false - type: object + type: integer description: "Group" interface_type: required: false diff --git a/actions/put.ipam.fhrp_groups.yaml b/actions/put.ipam.fhrp_groups.yaml index c7ef7cc1..c5fd4345 100644 --- a/actions/put.ipam.fhrp_groups.yaml +++ b/actions/put.ipam.fhrp_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a FHRP group object." enabled: true entry_point: run.py @@ -50,6 +50,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.ip_addresses.yaml b/actions/put.ipam.ip_addresses.yaml index d02b36dc..bb628ba9 100644 --- a/actions/put.ipam.ip_addresses.yaml +++ b/actions/put.ipam.ip_addresses.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a IP address object." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Address" vrf: required: false - type: object + type: integer description: "Vrf" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -75,6 +75,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.ip_ranges.yaml b/actions/put.ipam.ip_ranges.yaml index 5ae402ca..1f9073bf 100644 --- a/actions/put.ipam.ip_ranges.yaml +++ b/actions/put.ipam.ip_ranges.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a IP range object." enabled: true entry_point: run.py @@ -30,11 +30,11 @@ parameters: description: "End address" vrf: required: false - type: object + type: integer description: "Vrf" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -46,12 +46,16 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string @@ -71,7 +75,7 @@ parameters: mark_utilized: required: false type: boolean - description: "Report space as 100% utilized" + description: "Report space as fully utilized" id: required: true type: integer diff --git a/actions/put.ipam.prefixes.yaml b/actions/put.ipam.prefixes.yaml index 88687ae0..344effa2 100644 --- a/actions/put.ipam.prefixes.yaml +++ b/actions/put.ipam.prefixes.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a prefix object." enabled: true entry_point: run.py @@ -26,7 +26,7 @@ parameters: description: "Prefix" vrf: required: false - type: object + type: integer description: "Vrf" scope_type: required: false @@ -38,11 +38,11 @@ parameters: description: "Scope id" tenant: required: false - type: object + type: integer description: "Tenant" vlan: required: false - type: object + type: integer description: "Vlan" status: required: false @@ -55,7 +55,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" is_pool: required: false @@ -69,6 +69,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.rirs.yaml b/actions/put.ipam.rirs.yaml index e66ddbcc..4eca0f6b 100644 --- a/actions/put.ipam.rirs.yaml +++ b/actions/put.ipam.rirs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a RIR object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.ipam.roles.yaml b/actions/put.ipam.roles.yaml index 9462dd6a..0f82963b 100644 --- a/actions/put.ipam.roles.yaml +++ b/actions/put.ipam.roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a role object." enabled: true entry_point: run.py @@ -36,6 +36,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.ipam.route_targets.yaml b/actions/put.ipam.route_targets.yaml index d8cddd63..03a35303 100644 --- a/actions/put.ipam.route_targets.yaml +++ b/actions/put.ipam.route_targets.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a route target object." enabled: true entry_point: run.py @@ -26,12 +26,16 @@ parameters: description: "Route target value (formatted in accordance with RFC 4360)" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.service_templates.yaml b/actions/put.ipam.service_templates.yaml index 57ca9020..94d0208d 100644 --- a/actions/put.ipam.service_templates.yaml +++ b/actions/put.ipam.service_templates.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Put a service template object." +# NetBox API version: 4.6 +description: "Put a application service template object." enabled: true entry_point: run.py name: put.ipam.service_templates @@ -38,6 +38,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.services.yaml b/actions/put.ipam.services.yaml index cb9f4cb0..cf14ef7b 100644 --- a/actions/put.ipam.services.yaml +++ b/actions/put.ipam.services.yaml @@ -1,6 +1,6 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Put a service object." +# NetBox API version: 4.6 +description: "Put a application service object." enabled: true entry_point: run.py name: put.ipam.services @@ -50,6 +50,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.vlan_groups.yaml b/actions/put.ipam.vlan_groups.yaml index 28faeee3..186e1596 100644 --- a/actions/put.ipam.vlan_groups.yaml +++ b/actions/put.ipam.vlan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a VLAN group object." enabled: true entry_point: run.py @@ -42,12 +42,20 @@ parameters: description: "Vid ranges" tenant: required: false - type: object + type: integer description: "Tenant" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.ipam.vlan_translation_policies.yaml b/actions/put.ipam.vlan_translation_policies.yaml index 90814cc2..a36be769 100644 --- a/actions/put.ipam.vlan_translation_policies.yaml +++ b/actions/put.ipam.vlan_translation_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a VLAN translation policy object." enabled: true entry_point: run.py @@ -28,6 +28,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" id: required: true type: integer diff --git a/actions/put.ipam.vlan_translation_rules.yaml b/actions/put.ipam.vlan_translation_rules.yaml index 0013c133..fbadde92 100644 --- a/actions/put.ipam.vlan_translation_rules.yaml +++ b/actions/put.ipam.vlan_translation_rules.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a VLAN translation rule object." enabled: true entry_point: run.py diff --git a/actions/put.ipam.vlans.yaml b/actions/put.ipam.vlans.yaml index 6c9ccde6..08b24584 100644 --- a/actions/put.ipam.vlans.yaml +++ b/actions/put.ipam.vlans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a VLAN object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. site: required: false - type: object + type: integer description: "Site" group: required: false - type: object + type: integer description: "Group" vid: required: false @@ -38,7 +38,7 @@ parameters: description: "Name" tenant: required: false - type: object + type: integer description: "Tenant" status: required: false @@ -50,7 +50,7 @@ parameters: * `deprecated` - Deprecated" role: required: false - type: object + type: integer description: "Role" description: required: false @@ -64,6 +64,10 @@ parameters: required: false type: integer description: "Qinq svlan" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.ipam.vrfs.yaml b/actions/put.ipam.vrfs.yaml index 2edbb094..6b974d1c 100644 --- a/actions/put.ipam.vrfs.yaml +++ b/actions/put.ipam.vrfs.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a VRF object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Route distinguisher" tenant: required: false - type: object + type: integer description: "Tenant" enforce_unique: required: false @@ -40,6 +40,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.tenancy.contact_assignments.yaml b/actions/put.tenancy.contact_assignments.yaml index eb11a143..885df3c7 100644 --- a/actions/put.tenancy.contact_assignments.yaml +++ b/actions/put.tenancy.contact_assignments.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a contact assignment object." enabled: true entry_point: run.py @@ -30,11 +30,11 @@ parameters: description: "Object id" contact: required: false - type: object + type: integer description: "Contact" role: required: false - type: object + type: integer description: "Role" priority: required: false diff --git a/actions/put.tenancy.contact_groups.yaml b/actions/put.tenancy.contact_groups.yaml index 55624135..c79eeff7 100644 --- a/actions/put.tenancy.contact_groups.yaml +++ b/actions/put.tenancy.contact_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a contact group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.tenancy.contact_roles.yaml b/actions/put.tenancy.contact_roles.yaml index 6e0dbcd2..775335d8 100644 --- a/actions/put.tenancy.contact_roles.yaml +++ b/actions/put.tenancy.contact_roles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a contact role object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.tenancy.contacts.yaml b/actions/put.tenancy.contacts.yaml index f75aff56..35595f6a 100644 --- a/actions/put.tenancy.contacts.yaml +++ b/actions/put.tenancy.contacts.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a contact object." enabled: true entry_point: run.py @@ -52,6 +52,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.tenancy.tenant_groups.yaml b/actions/put.tenancy.tenant_groups.yaml index 783205b7..77929b17 100644 --- a/actions/put.tenancy.tenant_groups.yaml +++ b/actions/put.tenancy.tenant_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a tenant group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.tenancy.tenants.yaml b/actions/put.tenancy.tenants.yaml index b98dd603..95d337e6 100644 --- a/actions/put.tenancy.tenants.yaml +++ b/actions/put.tenancy.tenants.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a tenant object." enabled: true entry_point: run.py @@ -30,12 +30,16 @@ parameters: description: "Slug" group: required: false - type: object + type: integer description: "Group" description: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.users.groups.yaml b/actions/put.users.groups.yaml index 8ca7d1cd..f87775e8 100644 --- a/actions/put.users.groups.yaml +++ b/actions/put.users.groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a group object." enabled: true entry_point: run.py diff --git a/actions/put.users.owner_groups.yaml b/actions/put.users.owner_groups.yaml new file mode 100644 index 00000000..52f6ed38 --- /dev/null +++ b/actions/put.users.owner_groups.yaml @@ -0,0 +1,35 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Put a owner group object." +enabled: true +entry_point: run.py +name: put.users.owner_groups +parameters: + endpoint_uri: + default: "/users/owner-groups/{{ id }}/" + immutable: true + type: string + http_verb: + default: put + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + description: + required: false + type: string + description: "Description" + id: + required: true + type: integer + description: "ID of the object to put." +runner_type: python-script diff --git a/actions/put.dcim.cable_terminations.yaml b/actions/put.users.owners.yaml similarity index 64% rename from actions/put.dcim.cable_terminations.yaml rename to actions/put.users.owners.yaml index fc6b53ec..b194742a 100644 --- a/actions/put.dcim.cable_terminations.yaml +++ b/actions/put.users.owners.yaml @@ -1,12 +1,12 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 -description: "Put a cable termination object." +# NetBox API version: 4.6 +description: "Put a owner object." enabled: true entry_point: run.py -name: put.dcim.cable_terminations +name: put.users.owners parameters: endpoint_uri: - default: "/dcim/cable-terminations/{{ id }}/" + default: "/users/owners/{{ id }}/" immutable: true type: string http_verb: @@ -20,22 +20,26 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. - cable: + name: + required: false + type: string + description: "Name" + group: required: false type: integer - description: "Cable" - cable_end: + description: "Group" + description: required: false type: string - description: "End" - termination_type: + description: "Description" + user_groups: required: false - type: string - description: "Termination type" - termination_id: + type: array + description: "User groups" + users: required: false - type: integer - description: "Termination id" + type: array + description: "Users" id: required: true type: integer diff --git a/actions/put.users.permissions.yaml b/actions/put.users.permissions.yaml index 1d4856e0..ecfca08b 100644 --- a/actions/put.users.permissions.yaml +++ b/actions/put.users.permissions.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a permission object." enabled: true entry_point: run.py diff --git a/actions/put.users.tokens.yaml b/actions/put.users.tokens.yaml index b62d7d70..d47195ae 100644 --- a/actions/put.users.tokens.yaml +++ b/actions/put.users.tokens.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a token object." enabled: true entry_point: run.py @@ -20,10 +20,19 @@ parameters: fail_non_2xx: type: boolean description: Set action as failed when http return reponse status isn't 2xx. + version: + required: false + type: integer + description: "* `1` - v1 +* `2` - v2" user: required: false - type: object + type: integer description: "User" + description: + required: false + type: string + description: "Description" expires: required: false type: string @@ -32,18 +41,22 @@ parameters: required: false type: string description: "Last used" - key: + enabled: required: false - type: string - description: "Key" + type: boolean + description: "Disable to temporarily revoke this token without deleting it." write_enabled: required: false type: boolean - description: "Permit create/update/delete operations using this key" - description: + description: "Permit create/update/delete operations using this token" + pepper_id: + required: false + type: integer + description: "ID of the cryptographic pepper used to hash the token (v2 only)" + token: required: false type: string - description: "Description" + description: "Token" id: required: true type: integer diff --git a/actions/put.users.users.yaml b/actions/put.users.users.yaml index 57885fe1..52e77f4b 100644 --- a/actions/put.users.users.yaml +++ b/actions/put.users.users.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a user object." enabled: true entry_point: run.py @@ -40,10 +40,6 @@ parameters: required: false type: string description: "Email address" - is_staff: - required: false - type: boolean - description: "Staff status" is_active: required: false type: boolean diff --git a/actions/put.virtualization.cluster_groups.yaml b/actions/put.virtualization.cluster_groups.yaml index 8ab738e1..e28bbd19 100644 --- a/actions/put.virtualization.cluster_groups.yaml +++ b/actions/put.virtualization.cluster_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a cluster group object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.virtualization.cluster_types.yaml b/actions/put.virtualization.cluster_types.yaml index 661059f2..5cb3148f 100644 --- a/actions/put.virtualization.cluster_types.yaml +++ b/actions/put.virtualization.cluster_types.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a cluster type object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.virtualization.clusters.yaml b/actions/put.virtualization.clusters.yaml index 6352e26c..e5b569a2 100644 --- a/actions/put.virtualization.clusters.yaml +++ b/actions/put.virtualization.clusters.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a cluster object." enabled: true entry_point: run.py @@ -26,11 +26,11 @@ parameters: description: "Name" type: required: false - type: object + type: integer description: "Type" group: required: false - type: object + type: integer description: "Group" status: required: false @@ -42,7 +42,7 @@ parameters: * `offline` - Offline" tenant: required: false - type: object + type: integer description: "Tenant" scope_type: required: false @@ -56,6 +56,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.virtualization.interfaces.yaml b/actions/put.virtualization.interfaces.yaml index 469f9f9a..0941e247 100644 --- a/actions/put.virtualization.interfaces.yaml +++ b/actions/put.virtualization.interfaces.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a interface object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_machine: required: false - type: object + type: integer description: "Virtual machine" name: required: false @@ -46,7 +46,7 @@ parameters: description: "Mtu" primary_mac_address: required: false - type: object + type: integer description: "Primary mac address" description: required: false @@ -63,7 +63,7 @@ parameters: * `q-in-q` - Q-in-Q (802.1ad)" untagged_vlan: required: false - type: object + type: integer description: "Untagged vlan" tagged_vlans: required: false @@ -71,16 +71,20 @@ parameters: description: "Tagged vlans" qinq_svlan: required: false - type: object + type: integer description: "Qinq svlan" vlan_translation_policy: required: false - type: object + type: integer description: "Vlan translation policy" vrf: required: false - type: object + type: integer description: "Vrf" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.virtualization.virtual_disks.yaml b/actions/put.virtualization.virtual_disks.yaml index 3b2f318f..061cf207 100644 --- a/actions/put.virtualization.virtual_disks.yaml +++ b/actions/put.virtualization.virtual_disks.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a virtual disk object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. virtual_machine: required: false - type: object + type: integer description: "Virtual machine" name: required: false @@ -35,7 +35,11 @@ parameters: size: required: false type: integer - description: "Size (MB)" + description: "Size" + owner: + required: false + type: integer + description: "Owner" tags: required: false type: array diff --git a/actions/put.virtualization.virtual_machine_types.yaml b/actions/put.virtualization.virtual_machine_types.yaml new file mode 100644 index 00000000..c39bc12f --- /dev/null +++ b/actions/put.virtualization.virtual_machine_types.yaml @@ -0,0 +1,67 @@ +# This action was auto generated from the NetBox API Swagger Spec +# NetBox API version: 4.6 +description: "Put a virtual machine type object." +enabled: true +entry_point: run.py +name: put.virtualization.virtual_machine_types +parameters: + endpoint_uri: + default: "/virtualization/virtual-machine-types/{{ id }}/" + immutable: true + type: string + http_verb: + default: put + immutable: true + type: string + get_detail_route_eligible: + default: true + immutable: true + type: boolean + fail_non_2xx: + type: boolean + description: Set action as failed when http return reponse status isn't 2xx. + name: + required: false + type: string + description: "Name" + slug: + required: false + type: string + description: "Slug" + default_platform: + required: false + type: integer + description: "Default platform" + default_vcpus: + required: false + type: integer + description: "Default vcpus" + default_memory: + required: false + type: integer + description: "Default memory (MB)" + description: + required: false + type: string + description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" + tags: + required: false + type: array + description: "Array of tag strings" + custom_fields: + required: false + type: object + description: "Custom fields" + id: + required: true + type: integer + description: "ID of the object to put." +runner_type: python-script diff --git a/actions/put.virtualization.virtual_machines.yaml b/actions/put.virtualization.virtual_machines.yaml index 55c087e0..6175937c 100644 --- a/actions/put.virtualization.virtual_machines.yaml +++ b/actions/put.virtualization.virtual_machines.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a virtual machine object." enabled: true entry_point: run.py @@ -24,6 +24,14 @@ parameters: required: false type: string description: "Name" + virtual_machine_type: + required: false + type: integer + description: "Virtual machine type" + role: + required: false + type: integer + description: "Role" status: required: false type: string @@ -34,41 +42,35 @@ parameters: * `failed` - Failed * `decommissioning` - Decommissioning * `paused` - Paused" + start_on_boot: + required: false + type: string + description: "* `on` - On +* `off` - Off +* `laststate` - Last State" site: required: false - type: object + type: integer description: "Site" cluster: required: false - type: object + type: integer description: "Cluster" device: required: false - type: object + type: integer description: "Device" - serial: - required: false - type: string - description: "Serial number" - role: - required: false - type: object - description: "Role" - tenant: - required: false - type: object - description: "Tenant" platform: required: false - type: object + type: integer description: "Platform" primary_ip4: required: false - type: object + type: integer description: "Primary ip4" primary_ip6: required: false - type: object + type: integer description: "Primary ip6" vcpus: required: false @@ -77,31 +79,43 @@ parameters: memory: required: false type: integer - description: "Memory (MB)" + description: "Memory" disk: required: false type: integer - description: "Disk (MB)" + description: "Disk" description: required: false type: string description: "Description" + serial: + required: false + type: string + description: "Serial number" + tenant: + required: false + type: integer + description: "Tenant" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" - config_template: + tags: required: false - type: object - description: "Config template" + type: array + description: "Array of tag strings" local_context_data: required: false type: object description: "Local config context data takes precedence over source contexts in the final rendered config context" - tags: + config_template: required: false - type: array - description: "Array of tag strings" + type: integer + description: "Config template" custom_fields: required: false type: object diff --git a/actions/put.vpn.ike_policies.yaml b/actions/put.vpn.ike_policies.yaml index 47f466d4..f5c147d5 100644 --- a/actions/put.vpn.ike_policies.yaml +++ b/actions/put.vpn.ike_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a IKE policy object." enabled: true entry_point: run.py @@ -46,6 +46,10 @@ parameters: required: false type: string description: "Pre-shared key" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.vpn.ike_proposals.yaml b/actions/put.vpn.ike_proposals.yaml index 53fc21b1..d0e35f56 100644 --- a/actions/put.vpn.ike_proposals.yaml +++ b/actions/put.vpn.ike_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a IKE proposal object." enabled: true entry_point: run.py @@ -87,6 +87,10 @@ parameters: required: false type: integer description: "Security association lifetime (in seconds)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.vpn.ipsec_policies.yaml b/actions/put.vpn.ipsec_policies.yaml index 60d6ee03..40d606ec 100644 --- a/actions/put.vpn.ipsec_policies.yaml +++ b/actions/put.vpn.ipsec_policies.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a IPSec policy object." enabled: true entry_point: run.py @@ -61,6 +61,10 @@ parameters: * `32` - Group 32 * `33` - Group 33 * `34` - Group 34" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.vpn.ipsec_profiles.yaml b/actions/put.vpn.ipsec_profiles.yaml index 02ada3e8..4b2f5858 100644 --- a/actions/put.vpn.ipsec_profiles.yaml +++ b/actions/put.vpn.ipsec_profiles.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a IPSec profile object." enabled: true entry_point: run.py @@ -35,12 +35,16 @@ parameters: * `ah` - AH" ike_policy: required: false - type: object + type: integer description: "Ike policy" ipsec_policy: required: false - type: object + type: integer description: "Ipsec policy" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.vpn.ipsec_proposals.yaml b/actions/put.vpn.ipsec_proposals.yaml index 7a8f039a..22e1ce58 100644 --- a/actions/put.vpn.ipsec_proposals.yaml +++ b/actions/put.vpn.ipsec_proposals.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a IPSec proposal object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: integer description: "SA lifetime (KB)" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.vpn.l2vpn_terminations.yaml b/actions/put.vpn.l2vpn_terminations.yaml index d674c96d..20a60880 100644 --- a/actions/put.vpn.l2vpn_terminations.yaml +++ b/actions/put.vpn.l2vpn_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a L2VPN termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. l2vpn: required: false - type: object + type: integer description: "L2vpn" assigned_object_type: required: false diff --git a/actions/put.vpn.l2vpns.yaml b/actions/put.vpn.l2vpns.yaml index cdfd33a0..2eab261b 100644 --- a/actions/put.vpn.l2vpns.yaml +++ b/actions/put.vpn.l2vpns.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a L2VPN object." enabled: true entry_point: run.py @@ -67,13 +67,17 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string description: "Comments" tenant: required: false - type: object + type: integer description: "Tenant" tags: required: false diff --git a/actions/put.vpn.tunnel_groups.yaml b/actions/put.vpn.tunnel_groups.yaml index a0ce8a73..186d91e3 100644 --- a/actions/put.vpn.tunnel_groups.yaml +++ b/actions/put.vpn.tunnel_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a tunnel group object." enabled: true entry_point: run.py @@ -32,6 +32,14 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" + comments: + required: false + type: string + description: "Comments" tags: required: false type: array diff --git a/actions/put.vpn.tunnel_terminations.yaml b/actions/put.vpn.tunnel_terminations.yaml index 96e5141e..634a8320 100644 --- a/actions/put.vpn.tunnel_terminations.yaml +++ b/actions/put.vpn.tunnel_terminations.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a tunnel termination object." enabled: true entry_point: run.py @@ -22,7 +22,7 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. tunnel: required: false - type: object + type: integer description: "Tunnel" role: required: false @@ -40,7 +40,7 @@ parameters: description: "Termination id" outside_ip: required: false - type: object + type: integer description: "Outside ip" tags: required: false diff --git a/actions/put.vpn.tunnels.yaml b/actions/put.vpn.tunnels.yaml index 9d104679..fa74b15f 100644 --- a/actions/put.vpn.tunnels.yaml +++ b/actions/put.vpn.tunnels.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a tunnel object." enabled: true entry_point: run.py @@ -32,7 +32,7 @@ parameters: * `disabled` - Disabled" group: required: false - type: object + type: integer description: "Group" encapsulation: required: false @@ -47,11 +47,11 @@ parameters: * `pptp` - PPTP" ipsec_profile: required: false - type: object + type: integer description: "Ipsec profile" tenant: required: false - type: object + type: integer description: "Tenant" tunnel_id: required: false @@ -61,6 +61,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.wireless.wireless_lan_groups.yaml b/actions/put.wireless.wireless_lan_groups.yaml index b4ac0f64..73ba208b 100644 --- a/actions/put.wireless.wireless_lan_groups.yaml +++ b/actions/put.wireless.wireless_lan_groups.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a wireless LAN group object." enabled: true entry_point: run.py @@ -44,6 +44,10 @@ parameters: required: false type: object description: "Custom fields" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.wireless.wireless_lans.yaml b/actions/put.wireless.wireless_lans.yaml index 2e94f9bd..ebcad403 100644 --- a/actions/put.wireless.wireless_lans.yaml +++ b/actions/put.wireless.wireless_lans.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a wireless LAN object." enabled: true entry_point: run.py @@ -30,7 +30,7 @@ parameters: description: "Description" group: required: false - type: object + type: integer description: "Group" status: required: false @@ -41,7 +41,7 @@ parameters: * `deprecated` - Deprecated" vlan: required: false - type: object + type: integer description: "Vlan" scope_type: required: false @@ -53,7 +53,7 @@ parameters: description: "Scope id" tenant: required: false - type: object + type: integer description: "Tenant" auth_type: required: false @@ -67,6 +67,10 @@ parameters: required: false type: string description: "Pre-shared key" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/put.wireless.wireless_links.yaml b/actions/put.wireless.wireless_links.yaml index fb8248d8..a92faef3 100644 --- a/actions/put.wireless.wireless_links.yaml +++ b/actions/put.wireless.wireless_links.yaml @@ -1,5 +1,5 @@ # This action was auto generated from the NetBox API Swagger Spec -# NetBox API version: 4.3 +# NetBox API version: 4.6 description: "Put a wireless link object." enabled: true entry_point: run.py @@ -22,11 +22,11 @@ parameters: description: Set action as failed when http return reponse status isn't 2xx. interface_a: required: false - type: object + type: integer description: "Interface a" interface_b: required: false - type: object + type: integer description: "Interface b" ssid: required: false @@ -40,7 +40,7 @@ parameters: * `decommissioning` - Decommissioning" tenant: required: false - type: object + type: integer description: "Tenant" auth_type: required: false @@ -69,6 +69,10 @@ parameters: required: false type: string description: "Description" + owner: + required: false + type: integer + description: "Owner" comments: required: false type: string diff --git a/actions/run.py b/actions/run.py index dee0a29a..90b6e981 100644 --- a/actions/run.py +++ b/actions/run.py @@ -16,7 +16,8 @@ def run(self, endpoint_uri, http_verb, get_detail_route_eligible, fail_non_2xx=N """ # Determine effective fail_non_2xx behavior: # - If the caller explicitly provided fail_non_2xx (True/False), honor that. - # - Otherwise, fall back to the pack-level default_fail_non_2xx config option (default False). + # - Otherwise, fall back to the pack-level default_fail_non_2xx config + # option (default False). if fail_non_2xx is None: effective_fail_non_2xx = self.config.get("default_fail_non_2xx", False) else: diff --git a/assets/NetBox-REST-API-4.6.yaml b/assets/NetBox-REST-API-4.6.yaml new file mode 100644 index 00000000..f76a4dfe --- /dev/null +++ b/assets/NetBox-REST-API-4.6.yaml @@ -0,0 +1,205154 @@ +openapi: 3.0.3 +info: + title: NetBox REST API + version: 4.6.0 (4.6) + license: + name: Apache v2 License +paths: + /api/authentication-check/: + get: + operationId: authentication_check_retrieve + description: Return the user making the request, if authenticated successfully. + tags: + - authentication-check + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/circuits/circuit-group-assignments/: + get: + operationId: circuits_circuit_group_assignments_list + description: Get a list of Circuit group assignment objects. + parameters: + - in: query + name: circuit + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: circuit_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: group + schema: + type: array + items: + type: string + description: Circuit group (slug) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Circuit group (slug) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + description: Circuit group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + description: Circuit group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: member_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_id__empty + schema: + type: boolean + - in: query + name: member_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: member_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: priority + schema: + type: string + x-spec-enum-id: 0548fc537440bf9d + nullable: true + enum: + - inactive + - 'null' + - primary + - secondary + - tertiary + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + - in: query + name: priority__empty + schema: + type: boolean + - in: query + name: priority__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__n + schema: + type: string + x-spec-enum-id: 0548fc537440bf9d + nullable: true + enum: + - inactive + - 'null' + - primary + - secondary + - tertiary + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + - in: query + name: priority__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: provider + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_circuit + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: virtual_circuit_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCircuitGroupAssignmentList' + description: '' + post: + operationId: circuits_circuit_group_assignments_create + description: Post a list of Circuit group assignment objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroupAssignment' + description: '' + put: + operationId: circuits_circuit_group_assignments_bulk_update + description: Put a list of Circuit group assignment objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignment' + description: '' + patch: + operationId: circuits_circuit_group_assignments_bulk_partial_update + description: Patch a list of Circuit group assignment objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignment' + description: '' + delete: + operationId: circuits_circuit_group_assignments_bulk_destroy + description: Delete a list of Circuit group assignment objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuit-group-assignments/{id}/: + get: + operationId: circuits_circuit_group_assignments_retrieve + description: Get a Circuit group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Circuit group assignment. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroupAssignment' + description: '' + put: + operationId: circuits_circuit_group_assignments_update + description: Put a Circuit group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Circuit group assignment. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroupAssignment' + description: '' + patch: + operationId: circuits_circuit_group_assignments_partial_update + description: Patch a Circuit group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Circuit group assignment. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroupAssignment' + description: '' + delete: + operationId: circuits_circuit_group_assignments_destroy + description: Delete a Circuit group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Circuit group assignment. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuit-groups/: + get: + operationId: circuits_circuit_groups_list + description: Get a list of circuit group objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCircuitGroupList' + description: '' + post: + operationId: circuits_circuit_groups_create + description: Post a list of circuit group objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/CircuitGroupRequest' + - type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/CircuitGroupRequest' + - type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroup' + description: '' + put: + operationId: circuits_circuit_groups_bulk_update + description: Put a list of circuit group objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroup' + description: '' + patch: + operationId: circuits_circuit_groups_bulk_partial_update + description: Patch a list of circuit group objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroup' + description: '' + delete: + operationId: circuits_circuit_groups_bulk_destroy + description: Delete a list of circuit group objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuit-groups/{id}/: + get: + operationId: circuits_circuit_groups_retrieve + description: Get a circuit group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit group. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroup' + description: '' + put: + operationId: circuits_circuit_groups_update + description: Put a circuit group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit group. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/CircuitGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroup' + description: '' + patch: + operationId: circuits_circuit_groups_partial_update + description: Patch a circuit group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit group. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedCircuitGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedCircuitGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitGroup' + description: '' + delete: + operationId: circuits_circuit_groups_destroy + description: Delete a circuit group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit group. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuit-terminations/: + get: + operationId: circuits_circuit_terminations_list + description: Get a list of circuit termination objects. + parameters: + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: circuit_id + schema: + type: array + items: + type: integer + description: Circuit + explode: true + style: form + - in: query + name: circuit_id__n + schema: + type: array + items: + type: integer + description: Circuit + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: port_speed + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: port_speed__empty + schema: + type: boolean + - in: query + name: port_speed__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: port_speed__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: port_speed__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: port_speed__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: port_speed__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: pp_info + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__empty + schema: + type: boolean + - in: query + name: pp_info__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pp_info__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: provider + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider__n + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_id__n + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_network_id + schema: + type: array + items: + type: integer + description: ProviderNetwork (ID) + explode: true + style: form + - in: query + name: provider_network_id__n + schema: + type: array + items: + type: integer + description: ProviderNetwork (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: term_side + schema: + type: string + x-spec-enum-id: 95b8fcc737f355d0 + title: Termination side + enum: + - A + - Z + - 'null' + description: |- + * `A` - A + * `Z` - Z + - in: query + name: term_side__empty + schema: + type: boolean + - in: query + name: term_side__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__n + schema: + type: string + x-spec-enum-id: 95b8fcc737f355d0 + title: Termination side + enum: + - A + - Z + - 'null' + description: |- + * `A` - A + * `Z` - Z + - in: query + name: term_side__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: term_side__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: termination_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__empty + schema: + type: boolean + - in: query + name: termination_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: termination_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: upstream_speed + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: upstream_speed__empty + schema: + type: boolean + - in: query + name: upstream_speed__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: upstream_speed__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: upstream_speed__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: upstream_speed__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: upstream_speed__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: xconnect_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__empty + schema: + type: boolean + - in: query + name: xconnect_id__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: xconnect_id__regex + schema: + type: array + items: + type: string + explode: true + style: form + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCircuitTerminationList' + description: '' + post: + operationId: circuits_circuit_terminations_create + description: Post a list of circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/CircuitTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/CircuitTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitTermination' + description: '' + put: + operationId: circuits_circuit_terminations_bulk_update + description: Put a list of circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTermination' + description: '' + patch: + operationId: circuits_circuit_terminations_bulk_partial_update + description: Patch a list of circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTermination' + description: '' + delete: + operationId: circuits_circuit_terminations_bulk_destroy + description: Delete a list of circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuit-terminations/{id}/: + get: + operationId: circuits_circuit_terminations_retrieve + description: Get a circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit termination. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitTermination' + description: '' + put: + operationId: circuits_circuit_terminations_update + description: Put a circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit termination. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/CircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitTermination' + description: '' + patch: + operationId: circuits_circuit_terminations_partial_update + description: Patch a circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit termination. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedCircuitTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedCircuitTerminationRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitTermination' + description: '' + delete: + operationId: circuits_circuit_terminations_destroy + description: Delete a circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit termination. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuit-terminations/{id}/paths/: + get: + operationId: circuits_circuit_terminations_paths_retrieve + description: Return all CablePaths which traverse a given pass-through port. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit termination. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitTermination' + description: '' + /api/circuits/circuit-types/: + get: + operationId: circuits_circuit_types_list + description: Get a list of circuit type objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCircuitTypeList' + description: '' + post: + operationId: circuits_circuit_types_create + description: Post a list of circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/CircuitTypeRequest' + - type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/CircuitTypeRequest' + - type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitType' + description: '' + put: + operationId: circuits_circuit_types_bulk_update + description: Put a list of circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitType' + description: '' + patch: + operationId: circuits_circuit_types_bulk_partial_update + description: Patch a list of circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitType' + description: '' + delete: + operationId: circuits_circuit_types_bulk_destroy + description: Delete a list of circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuit-types/{id}/: + get: + operationId: circuits_circuit_types_retrieve + description: Get a circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit type. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitType' + description: '' + put: + operationId: circuits_circuit_types_update + description: Put a circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit type. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/CircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitType' + description: '' + patch: + operationId: circuits_circuit_types_partial_update + description: Patch a circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit type. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedCircuitTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedCircuitTypeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CircuitType' + description: '' + delete: + operationId: circuits_circuit_types_destroy + description: Delete a circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit type. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuits/: + get: + operationId: circuits_circuits_list + description: Get a list of circuit objects. + parameters: + - in: query + name: cid + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__empty + schema: + type: boolean + - in: query + name: cid__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: commit_rate + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: commit_rate__empty + schema: + type: boolean + - in: query + name: commit_rate__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: commit_rate__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: commit_rate__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: commit_rate__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: commit_rate__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__empty + schema: + type: boolean + - in: query + name: distance__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance_unit + schema: + type: string + x-spec-enum-id: b1169a409430c02e + nullable: true + enum: + - ft + - km + - m + - mi + - 'null' + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + - in: query + name: distance_unit__empty + schema: + type: boolean + - in: query + name: distance_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__n + schema: + type: string + x-spec-enum-id: b1169a409430c02e + nullable: true + enum: + - ft + - km + - m + - mi + - 'null' + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + - in: query + name: distance_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: install_date + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: install_date__empty + schema: + type: boolean + - in: query + name: install_date__gt + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: install_date__gte + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: install_date__lt + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: install_date__lte + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: install_date__n + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: provider + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider__n + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider_account + schema: + type: array + items: + type: string + title: Account ID + description: Provider account (account) + explode: true + style: form + - in: query + name: provider_account__n + schema: + type: array + items: + type: string + title: Account ID + description: Provider account (account) + explode: true + style: form + - in: query + name: provider_account_id + schema: + type: array + items: + type: integer + description: Provider account (ID) + explode: true + style: form + - in: query + name: provider_account_id__n + schema: + type: array + items: + type: integer + description: Provider account (ID) + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_id__n + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_network_id + schema: + type: array + items: + type: integer + description: Provider network (ID) + explode: true + style: form + - in: query + name: provider_network_id__n + schema: + type: array + items: + type: integer + description: Provider network (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: termination_a_id + schema: + type: array + items: + type: integer + nullable: true + description: Termination A (ID) + explode: true + style: form + - in: query + name: termination_a_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Termination A (ID) + explode: true + style: form + - in: query + name: termination_date + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: termination_date__empty + schema: + type: boolean + - in: query + name: termination_date__gt + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: termination_date__gte + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: termination_date__lt + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: termination_date__lte + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: termination_date__n + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: termination_z_id + schema: + type: array + items: + type: integer + nullable: true + description: Termination A (ID) + explode: true + style: form + - in: query + name: termination_z_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Termination A (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + description: Circuit type (slug) + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + description: Circuit type (slug) + explode: true + style: form + - in: query + name: type_id + schema: + type: array + items: + type: integer + description: Circuit type (ID) + explode: true + style: form + - in: query + name: type_id__n + schema: + type: array + items: + type: integer + description: Circuit type (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCircuitList' + description: '' + post: + operationId: circuits_circuits_create + description: Post a list of circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCircuitRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCircuitRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCircuitRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Circuit' + description: '' + put: + operationId: circuits_circuits_bulk_update + description: Put a list of circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Circuit' + description: '' + patch: + operationId: circuits_circuits_bulk_partial_update + description: Patch a list of circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Circuit' + description: '' + delete: + operationId: circuits_circuits_bulk_destroy + description: Delete a list of circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/circuits/{id}/: + get: + operationId: circuits_circuits_retrieve + description: Get a circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Circuit' + description: '' + put: + operationId: circuits_circuits_update + description: Put a circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableCircuitRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableCircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Circuit' + description: '' + patch: + operationId: circuits_circuits_partial_update + description: Patch a circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableCircuitRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableCircuitRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Circuit' + description: '' + delete: + operationId: circuits_circuits_destroy + description: Delete a circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this circuit. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/provider-accounts/: + get: + operationId: circuits_provider_accounts_list + description: Get a list of provider account objects. + parameters: + - in: query + name: account + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__empty + schema: + type: boolean + - in: query + name: account__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: account__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: provider + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider__n + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_id__n + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedProviderAccountList' + description: '' + post: + operationId: circuits_provider_accounts_create + description: Post a list of provider account objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ProviderAccountRequest' + - type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ProviderAccountRequest' + - type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderAccount' + description: '' + put: + operationId: circuits_provider_accounts_bulk_update + description: Put a list of provider account objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccount' + description: '' + patch: + operationId: circuits_provider_accounts_bulk_partial_update + description: Patch a list of provider account objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccount' + description: '' + delete: + operationId: circuits_provider_accounts_bulk_destroy + description: Delete a list of provider account objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderAccountRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/provider-accounts/{id}/: + get: + operationId: circuits_provider_accounts_retrieve + description: Get a provider account object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider account. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderAccount' + description: '' + put: + operationId: circuits_provider_accounts_update + description: Put a provider account object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider account. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProviderAccountRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderAccount' + description: '' + patch: + operationId: circuits_provider_accounts_partial_update + description: Patch a provider account object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider account. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedProviderAccountRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedProviderAccountRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderAccount' + description: '' + delete: + operationId: circuits_provider_accounts_destroy + description: Delete a provider account object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider account. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/provider-networks/: + get: + operationId: circuits_provider_networks_list + description: Get a list of provider network objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: provider + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider__n + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_id__n + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: service_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__empty + schema: + type: boolean + - in: query + name: service_id__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: service_id__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedProviderNetworkList' + description: '' + post: + operationId: circuits_provider_networks_create + description: Post a list of provider network objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ProviderNetworkRequest' + - type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ProviderNetworkRequest' + - type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderNetwork' + description: '' + put: + operationId: circuits_provider_networks_bulk_update + description: Put a list of provider network objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetwork' + description: '' + patch: + operationId: circuits_provider_networks_bulk_partial_update + description: Patch a list of provider network objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetwork' + description: '' + delete: + operationId: circuits_provider_networks_bulk_destroy + description: Delete a list of provider network objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderNetworkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/provider-networks/{id}/: + get: + operationId: circuits_provider_networks_retrieve + description: Get a provider network object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider network. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderNetwork' + description: '' + put: + operationId: circuits_provider_networks_update + description: Put a provider network object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider network. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderNetworkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProviderNetworkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderNetwork' + description: '' + patch: + operationId: circuits_provider_networks_partial_update + description: Patch a provider network object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider network. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedProviderNetworkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedProviderNetworkRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderNetwork' + description: '' + delete: + operationId: circuits_provider_networks_destroy + description: Delete a provider network object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider network. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/providers/: + get: + operationId: circuits_providers_list + description: Get a list of provider objects. + parameters: + - in: query + name: asn + schema: + type: array + items: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + description: ASN + explode: true + style: form + - in: query + name: asn__n + schema: + type: array + items: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + description: ASN + explode: true + style: form + - in: query + name: asn_id + schema: + type: array + items: + type: integer + description: ASN (ID) + explode: true + style: form + - in: query + name: asn_id__n + schema: + type: array + items: + type: integer + description: ASN (ID) + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site + explode: true + style: form + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedProviderList' + description: '' + post: + operationId: circuits_providers_create + description: Post a list of provider objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ProviderRequest' + - type: array + items: + $ref: '#/components/schemas/ProviderRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ProviderRequest' + - type: array + items: + $ref: '#/components/schemas/ProviderRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + description: '' + put: + operationId: circuits_providers_bulk_update + description: Put a list of provider objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Provider' + description: '' + patch: + operationId: circuits_providers_bulk_partial_update + description: Patch a list of provider objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Provider' + description: '' + delete: + operationId: circuits_providers_bulk_destroy + description: Delete a list of provider objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ProviderRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/providers/{id}/: + get: + operationId: circuits_providers_retrieve + description: Get a provider object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + description: '' + put: + operationId: circuits_providers_update + description: Put a provider object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProviderRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProviderRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + description: '' + patch: + operationId: circuits_providers_partial_update + description: Patch a provider object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedProviderRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedProviderRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Provider' + description: '' + delete: + operationId: circuits_providers_destroy + description: Delete a provider object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this provider. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/virtual-circuit-terminations/: + get: + operationId: circuits_virtual_circuit_terminations_list + description: Get a list of virtual circuit termination objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: provider + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider__n + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider_account + schema: + type: array + items: + type: string + title: Account ID + description: Provider account (account) + explode: true + style: form + - in: query + name: provider_account__n + schema: + type: array + items: + type: string + title: Account ID + description: Provider account (account) + explode: true + style: form + - in: query + name: provider_account_id + schema: + type: array + items: + type: integer + description: Provider account (ID) + explode: true + style: form + - in: query + name: provider_account_id__n + schema: + type: array + items: + type: integer + description: Provider account (ID) + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_id__n + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_network_id + schema: + type: array + items: + type: integer + description: Provider network (ID) + explode: true + style: form + - in: query + name: provider_network_id__n + schema: + type: array + items: + type: integer + description: Provider network (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: role + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__empty + schema: + type: boolean + - in: query + name: role__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_circuit_id + schema: + type: array + items: + type: integer + description: Virtual circuit + explode: true + style: form + - in: query + name: virtual_circuit_id__n + schema: + type: array + items: + type: integer + description: Virtual circuit + explode: true + style: form + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualCircuitTerminationList' + description: '' + post: + operationId: circuits_virtual_circuit_terminations_create + description: Post a list of virtual circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitTermination' + description: '' + put: + operationId: circuits_virtual_circuit_terminations_bulk_update + description: Put a list of virtual circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTermination' + description: '' + patch: + operationId: circuits_virtual_circuit_terminations_bulk_partial_update + description: Patch a list of virtual circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTermination' + description: '' + delete: + operationId: circuits_virtual_circuit_terminations_bulk_destroy + description: Delete a list of virtual circuit termination objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/virtual-circuit-terminations/{id}/: + get: + operationId: circuits_virtual_circuit_terminations_retrieve + description: Get a virtual circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit termination. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitTermination' + description: '' + put: + operationId: circuits_virtual_circuit_terminations_update + description: Put a virtual circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit termination. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitTermination' + description: '' + patch: + operationId: circuits_virtual_circuit_terminations_partial_update + description: Patch a virtual circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit termination. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualCircuitTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualCircuitTerminationRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitTermination' + description: '' + delete: + operationId: circuits_virtual_circuit_terminations_destroy + description: Delete a virtual circuit termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit termination. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/virtual-circuit-terminations/{id}/paths/: + get: + operationId: circuits_virtual_circuit_terminations_paths_retrieve + description: Return all CablePaths which traverse a given pass-through port. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit termination. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitTermination' + description: '' + /api/circuits/virtual-circuit-types/: + get: + operationId: circuits_virtual_circuit_types_list + description: Get a list of virtual circuit type objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualCircuitTypeList' + description: '' + post: + operationId: circuits_virtual_circuit_types_create + description: Post a list of virtual circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/VirtualCircuitTypeRequest' + - type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/VirtualCircuitTypeRequest' + - type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitType' + description: '' + put: + operationId: circuits_virtual_circuit_types_bulk_update + description: Put a list of virtual circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitType' + description: '' + patch: + operationId: circuits_virtual_circuit_types_bulk_partial_update + description: Patch a list of virtual circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitType' + description: '' + delete: + operationId: circuits_virtual_circuit_types_bulk_destroy + description: Delete a list of virtual circuit type objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/virtual-circuit-types/{id}/: + get: + operationId: circuits_virtual_circuit_types_retrieve + description: Get a virtual circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit type. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitType' + description: '' + put: + operationId: circuits_virtual_circuit_types_update + description: Put a virtual circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit type. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/VirtualCircuitTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitType' + description: '' + patch: + operationId: circuits_virtual_circuit_types_partial_update + description: Patch a virtual circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit type. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVirtualCircuitTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedVirtualCircuitTypeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuitType' + description: '' + delete: + operationId: circuits_virtual_circuit_types_destroy + description: Delete a virtual circuit type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit type. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/virtual-circuits/: + get: + operationId: circuits_virtual_circuits_list + description: Get a list of virtual circuit objects. + parameters: + - in: query + name: cid + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__empty + schema: + type: boolean + - in: query + name: cid__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cid__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: provider + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider__n + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider_account + schema: + type: array + items: + type: string + title: Account ID + description: Provider account (account) + explode: true + style: form + - in: query + name: provider_account__n + schema: + type: array + items: + type: string + title: Account ID + description: Provider account (account) + explode: true + style: form + - in: query + name: provider_account_id + schema: + type: array + items: + type: integer + description: Provider account (ID) + explode: true + style: form + - in: query + name: provider_account_id__n + schema: + type: array + items: + type: integer + description: Provider account (ID) + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_id__n + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_network_id + schema: + type: array + items: + type: integer + description: Provider network (ID) + explode: true + style: form + - in: query + name: provider_network_id__n + schema: + type: array + items: + type: integer + description: Provider network (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a239d878b6666a4 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + description: Virtual circuit type (slug) + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + description: Virtual circuit type (slug) + explode: true + style: form + - in: query + name: type_id + schema: + type: array + items: + type: integer + description: Virtual circuit type (ID) + explode: true + style: form + - in: query + name: type_id__n + schema: + type: array + items: + type: integer + description: Virtual circuit type (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualCircuitList' + description: '' + post: + operationId: circuits_virtual_circuits_create + description: Post a list of virtual circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualCircuitRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualCircuitRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualCircuitRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualCircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuit' + description: '' + put: + operationId: circuits_virtual_circuits_bulk_update + description: Put a list of virtual circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuit' + description: '' + patch: + operationId: circuits_virtual_circuits_bulk_partial_update + description: Patch a list of virtual circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuit' + description: '' + delete: + operationId: circuits_virtual_circuits_bulk_destroy + description: Delete a list of virtual circuit objects. + tags: + - circuits + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/circuits/virtual-circuits/{id}/: + get: + operationId: circuits_virtual_circuits_retrieve + description: Get a virtual circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuit' + description: '' + put: + operationId: circuits_virtual_circuits_update + description: Put a virtual circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVirtualCircuitRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVirtualCircuitRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuit' + description: '' + patch: + operationId: circuits_virtual_circuits_partial_update + description: Patch a virtual circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit. + required: true + tags: + - circuits + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualCircuitRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualCircuitRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualCircuit' + description: '' + delete: + operationId: circuits_virtual_circuits_destroy + description: Delete a virtual circuit object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual circuit. + required: true + tags: + - circuits + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/core/background-queues/: + get: + operationId: core_background_queues_retrieve + description: |- + Retrieve a list of RQ Queues. + Note: Queue names are not URL safe, so not returning a detail view. + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/core/background-queues/{name}/: + get: + operationId: core_background_queues_retrieve_by_name + description: |- + Retrieve a list of RQ Queues. + Note: Queue names are not URL safe, so not returning a detail view. + parameters: + - in: path + name: name + schema: + type: string + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/core/background-tasks/: + get: + operationId: core_background_tasks_retrieve + description: Retrieve a list of RQ Tasks. + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/core/background-tasks/{id}/: + get: + operationId: core_background_tasks_retrieve_by_id + description: Retrieve a list of RQ Tasks. + parameters: + - in: path + name: id + schema: + type: string + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/core/background-tasks/{id}/delete/: + post: + operationId: core_background_tasks_delete_create + description: Retrieve a list of RQ Tasks. + parameters: + - in: path + name: id + schema: + type: string + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTask' + description: '' + /api/core/background-tasks/{id}/enqueue/: + post: + operationId: core_background_tasks_enqueue_create + description: Retrieve a list of RQ Tasks. + parameters: + - in: path + name: id + schema: + type: string + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTask' + description: '' + /api/core/background-tasks/{id}/requeue/: + post: + operationId: core_background_tasks_requeue_create + description: Retrieve a list of RQ Tasks. + parameters: + - in: path + name: id + schema: + type: string + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTask' + description: '' + /api/core/background-tasks/{id}/stop/: + post: + operationId: core_background_tasks_stop_create + description: Retrieve a list of RQ Tasks. + parameters: + - in: path + name: id + schema: + type: string + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/BackgroundTaskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BackgroundTask' + description: '' + /api/core/background-workers/: + get: + operationId: core_background_workers_retrieve + description: Retrieve a list of RQ Workers. + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/core/background-workers/{name}/: + get: + operationId: core_background_workers_retrieve_by_name + description: Retrieve a list of RQ Workers. + parameters: + - in: path + name: name + schema: + type: string + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/core/data-files/: + get: + operationId: core_data_files_list + description: Get a list of data file objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: hash + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__empty + schema: + type: boolean + - in: query + name: hash__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: hash__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: path + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__empty + schema: + type: boolean + - in: query + name: path__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: path__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + - in: query + name: size + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__empty + schema: + type: boolean + - in: query + name: size__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: source + schema: + type: array + items: + type: string + description: Data source (name) + explode: true + style: form + - in: query + name: source__n + schema: + type: array + items: + type: string + description: Data source (name) + explode: true + style: form + - in: query + name: source_id + schema: + type: array + items: + type: integer + description: Data source (ID) + explode: true + style: form + - in: query + name: source_id__n + schema: + type: array + items: + type: integer + description: Data source (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDataFileList' + description: '' + /api/core/data-files/{id}/: + get: + operationId: core_data_files_retrieve + description: Get a data file object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this data file. + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DataFile' + description: '' + /api/core/data-sources/: + get: + operationId: core_data_sources_list + description: Get a list of data source objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_synced + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_synced__empty + schema: + type: boolean + - in: query + name: last_synced__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_synced__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_synced__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_synced__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_synced__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: source_url + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__empty + schema: + type: boolean + - in: query + name: source_url__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: source_url__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: sync_interval + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__ic + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__ie + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__iew + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__iregex + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__isw + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__n + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__nic + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__nie + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__niew + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__nisw + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: sync_interval__regex + schema: + type: array + items: + type: integer + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDataSourceList' + description: '' + post: + operationId: core_data_sources_create + description: Post a list of data source objects. + tags: + - core + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDataSourceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDataSourceRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDataSourceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDataSourceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DataSource' + description: '' + put: + operationId: core_data_sources_bulk_update + description: Put a list of data source objects. + tags: + - core + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DataSourceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DataSourceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DataSource' + description: '' + patch: + operationId: core_data_sources_bulk_partial_update + description: Patch a list of data source objects. + tags: + - core + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DataSourceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DataSourceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DataSource' + description: '' + delete: + operationId: core_data_sources_bulk_destroy + description: Delete a list of data source objects. + tags: + - core + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DataSourceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DataSourceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/core/data-sources/{id}/: + get: + operationId: core_data_sources_retrieve + description: Get a data source object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this data source. + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DataSource' + description: '' + put: + operationId: core_data_sources_update + description: Put a data source object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this data source. + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableDataSourceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableDataSourceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DataSource' + description: '' + patch: + operationId: core_data_sources_partial_update + description: Patch a data source object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this data source. + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableDataSourceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableDataSourceRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DataSource' + description: '' + delete: + operationId: core_data_sources_destroy + description: Delete a data source object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this data source. + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/core/data-sources/{id}/sync/: + post: + operationId: core_data_sources_sync_create + description: Enqueue a job to synchronize the DataSource. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this data source. + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableDataSourceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableDataSourceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DataSource' + description: '' + /api/core/jobs/: + get: + operationId: core_jobs_list + description: Retrieve a list of job results + parameters: + - in: query + name: completed + schema: + type: string + format: date-time + - in: query + name: completed__after + schema: + type: string + format: date-time + - in: query + name: completed__before + schema: + type: string + format: date-time + - in: query + name: created + schema: + type: string + format: date-time + - in: query + name: created__after + schema: + type: string + format: date-time + - in: query + name: created__before + schema: + type: string + format: date-time + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interval + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interval__empty + schema: + type: boolean + - in: query + name: interval__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interval__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interval__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interval__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interval__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: job_id + schema: + type: string + format: uuid + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__empty + schema: + type: boolean + - in: query + name: object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: queue_name + schema: + type: string + - in: query + name: queue_name__empty + schema: + type: boolean + - in: query + name: queue_name__ic + schema: + type: string + - in: query + name: queue_name__ie + schema: + type: string + - in: query + name: queue_name__iew + schema: + type: string + - in: query + name: queue_name__iregex + schema: + type: string + - in: query + name: queue_name__isw + schema: + type: string + - in: query + name: queue_name__n + schema: + type: string + - in: query + name: queue_name__nic + schema: + type: string + - in: query + name: queue_name__nie + schema: + type: string + - in: query + name: queue_name__niew + schema: + type: string + - in: query + name: queue_name__nisw + schema: + type: string + - in: query + name: queue_name__regex + schema: + type: string + - in: query + name: scheduled + schema: + type: string + format: date-time + - in: query + name: scheduled__after + schema: + type: string + format: date-time + - in: query + name: scheduled__before + schema: + type: string + format: date-time + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: started + schema: + type: string + format: date-time + - in: query + name: started__after + schema: + type: string + format: date-time + - in: query + name: started__before + schema: + type: string + format: date-time + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: b3049df95b935eab + explode: true + style: form + - in: query + name: user + schema: + type: integer + - in: query + name: user__n + schema: + type: integer + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedJobList' + description: '' + /api/core/jobs/{id}/: + get: + operationId: core_jobs_retrieve + description: Retrieve a list of job results + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this job. + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + description: '' + /api/core/object-changes/: + get: + operationId: core_object_changes_list + description: Retrieve a list of recent changes. + parameters: + - in: query + name: action + schema: + type: string + x-spec-enum-id: 36ce3d432464454d + enum: + - create + - delete + - 'null' + - update + description: |- + * `create` - Created + * `update` - Updated + * `delete` - Deleted + - in: query + name: action__empty + schema: + type: boolean + - in: query + name: action__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__n + schema: + type: string + x-spec-enum-id: 36ce3d432464454d + enum: + - create + - delete + - 'null' + - update + description: |- + * `create` - Created + * `update` - Updated + * `delete` - Deleted + - in: query + name: action__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: changed_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: changed_object_id__empty + schema: + type: boolean + - in: query + name: changed_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: changed_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: changed_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: changed_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: changed_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: changed_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: changed_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: changed_object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: changed_object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: object_repr + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__empty + schema: + type: boolean + - in: query + name: object_repr__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_repr__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: related_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: related_object_id__empty + schema: + type: boolean + - in: query + name: related_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: related_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: related_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: related_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: related_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: related_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: related_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: request_id + schema: + type: string + format: uuid + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: time_after + schema: + type: string + format: date-time + - in: query + name: time_before + schema: + type: string + format: date-time + - in: query + name: user + schema: + type: array + items: + type: string + description: User name + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User name + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: user_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__empty + schema: + type: boolean + - in: query + name: user_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: user_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedObjectChangeList' + description: '' + /api/core/object-changes/{id}/: + get: + operationId: core_object_changes_retrieve + description: Retrieve a list of recent changes. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this object change. + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectChange' + description: '' + /api/core/object-types/: + get: + operationId: core_object_types_list + description: Read-only list of ObjectTypes. + parameters: + - in: query + name: app_label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__empty + schema: + type: boolean + - in: query + name: app_label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: app_label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: features + schema: + type: string + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: model + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__empty + schema: + type: boolean + - in: query + name: model__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: public + schema: + type: boolean + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedObjectTypeList' + description: '' + /api/core/object-types/{id}/: + get: + operationId: core_object_types_retrieve + description: Read-only list of ObjectTypes. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this object type. + required: true + tags: + - core + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectType' + description: '' + /api/dcim/cable-bundles/: + get: + operationId: dcim_cable_bundles_list + description: Get a list of cable bundle objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCableBundleList' + description: '' + post: + operationId: dcim_cable_bundles_create + description: Post a list of cable bundle objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/CableBundleRequest' + - type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/CableBundleRequest' + - type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CableBundle' + description: '' + put: + operationId: dcim_cable_bundles_bulk_update + description: Put a list of cable bundle objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundle' + description: '' + patch: + operationId: dcim_cable_bundles_bulk_partial_update + description: Patch a list of cable bundle objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundle' + description: '' + delete: + operationId: dcim_cable_bundles_bulk_destroy + description: Delete a list of cable bundle objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CableBundleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/cable-bundles/{id}/: + get: + operationId: dcim_cable_bundles_retrieve + description: Get a cable bundle object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable bundle. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CableBundle' + description: '' + put: + operationId: dcim_cable_bundles_update + description: Put a cable bundle object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable bundle. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CableBundleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/CableBundleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CableBundle' + description: '' + patch: + operationId: dcim_cable_bundles_partial_update + description: Patch a cable bundle object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable bundle. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedCableBundleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedCableBundleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CableBundle' + description: '' + delete: + operationId: dcim_cable_bundles_destroy + description: Delete a cable bundle object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable bundle. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/cable-terminations/: + get: + operationId: dcim_cable_terminations_list + description: Get a list of cable termination objects. + parameters: + - in: query + name: cable + schema: + type: integer + - in: query + name: cable__n + schema: + type: integer + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + title: End + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + title: End + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: termination_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__empty + schema: + type: boolean + - in: query + name: termination_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: termination_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCableTerminationList' + description: '' + /api/dcim/cable-terminations/{id}/: + get: + operationId: dcim_cable_terminations_retrieve + description: Get a cable termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable termination. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CableTermination' + description: '' + /api/dcim/cables/: + get: + operationId: dcim_cables_list + description: Get a list of cable objects. + parameters: + - in: query + name: bundle + schema: + type: array + items: + type: string + description: Cable bundle (name) + explode: true + style: form + - in: query + name: bundle__n + schema: + type: array + items: + type: string + description: Cable bundle (name) + explode: true + style: form + - in: query + name: bundle_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable bundle (ID) + explode: true + style: form + - in: query + name: bundle_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable bundle (ID) + explode: true + style: form + - in: query + name: circuittermination_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: consoleport_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: consoleserverport_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: frontport_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: length + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: length__empty + schema: + type: boolean + - in: query + name: length__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: length__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: length__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: length__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: length__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: length_unit + schema: + type: string + x-spec-enum-id: 6e7645525ba02462 + nullable: true + enum: + - cm + - ft + - in + - km + - m + - mi + - 'null' + description: |- + * `km` - Kilometers + * `m` - Meters + * `cm` - Centimeters + * `mi` - Miles + * `ft` - Feet + * `in` - Inches + - in: query + name: length_unit__empty + schema: + type: boolean + - in: query + name: length_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__n + schema: + type: string + x-spec-enum-id: 6e7645525ba02462 + nullable: true + enum: + - cm + - ft + - in + - km + - m + - mi + - 'null' + description: |- + * `km` - Kilometers + * `m` - Meters + * `cm` - Centimeters + * `mi` - Miles + * `ft` - Feet + * `in` - Inches + - in: query + name: length_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: length_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: powerfeed_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: poweroutlet_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: powerport_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: profile + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__empty + schema: + type: boolean + - in: query + name: profile__ic + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__ie + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__iew + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__isw + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__n + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__nic + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__nie + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__niew + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: profile__regex + schema: + type: array + items: + type: string + x-spec-enum-id: f566e6df6572f5d0 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rearport_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: termination_a_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_a_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: termination_a_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: termination_b_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_b_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: termination_b_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + explode: true + style: form + - in: query + name: unterminated + schema: + type: boolean + description: Unterminated + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCableList' + description: '' + post: + operationId: dcim_cables_create + description: Post a list of cable objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCableRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCableRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCableRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCableRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Cable' + description: '' + put: + operationId: dcim_cables_bulk_update + description: Put a list of cable objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CableRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Cable' + description: '' + patch: + operationId: dcim_cables_bulk_partial_update + description: Patch a list of cable objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CableRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Cable' + description: '' + delete: + operationId: dcim_cables_bulk_destroy + description: Delete a list of cable objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CableRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CableRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/cables/{id}/: + get: + operationId: dcim_cables_retrieve + description: Get a cable object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cable' + description: '' + put: + operationId: dcim_cables_update + description: Put a cable object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableCableRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableCableRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cable' + description: '' + patch: + operationId: dcim_cables_partial_update + description: Patch a cable object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableCableRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableCableRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cable' + description: '' + delete: + operationId: dcim_cables_destroy + description: Delete a cable object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cable. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/connected-device/: + get: + operationId: dcim_connected_device_list + description: |- + This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer + 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: + - in: query + name: peer_device + schema: + type: string + description: The name of the peer device + required: true + - in: query + name: peer_interface + schema: + type: string + description: The name of the peer interface + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Device' + description: '' + /api/dcim/console-port-templates/: + get: + operationId: dcim_console_port_templates_list + description: Get a list of console port template objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + enum: + - Other + - Serial + - USB + - 'null' + description: |- + * `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')] + * `Other` - [('other', 'Other')] + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__n + schema: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + enum: + - Other + - Serial + - USB + - 'null' + description: |- + * `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')] + * `Other` - [('other', 'Other')] + - in: query + name: type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConsolePortTemplateList' + description: '' + post: + operationId: dcim_console_port_templates_create + description: Post a list of console port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsolePortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsolePortTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsolePortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsolePortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePortTemplate' + description: '' + put: + operationId: dcim_console_port_templates_bulk_update + description: Put a list of console port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplate' + description: '' + patch: + operationId: dcim_console_port_templates_bulk_partial_update + description: Patch a list of console port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplate' + description: '' + delete: + operationId: dcim_console_port_templates_bulk_destroy + description: Delete a list of console port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-port-templates/{id}/: + get: + operationId: dcim_console_port_templates_retrieve + description: Get a console port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePortTemplate' + description: '' + put: + operationId: dcim_console_port_templates_update + description: Put a console port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableConsolePortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableConsolePortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePortTemplate' + description: '' + patch: + operationId: dcim_console_port_templates_partial_update + description: Patch a console port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableConsolePortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableConsolePortTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePortTemplate' + description: '' + delete: + operationId: dcim_console_port_templates_destroy + description: Delete a console port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-ports/: + get: + operationId: dcim_console_ports_list + description: Get a list of console port objects. + parameters: + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: connected + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: speed + schema: + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + enum: + - 115200 + - 1200 + - 19200 + - 2400 + - 38400 + - 4800 + - 57600 + - 9600 + - 'null' + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + - in: query + name: speed__ic + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__ie + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__iew + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__iregex + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__isw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__n + schema: + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + enum: + - 115200 + - 1200 + - 19200 + - 2400 + - 38400 + - 4800 + - 57600 + - 9600 + - 'null' + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + - in: query + name: speed__nic + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__nie + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__niew + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__nisw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__regex + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConsolePortList' + description: '' + post: + operationId: dcim_console_ports_create + description: Post a list of console port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsolePortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsolePortRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsolePortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsolePortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePort' + description: '' + put: + operationId: dcim_console_ports_bulk_update + description: Put a list of console port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePort' + description: '' + patch: + operationId: dcim_console_ports_bulk_partial_update + description: Patch a list of console port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePort' + description: '' + delete: + operationId: dcim_console_ports_bulk_destroy + description: Delete a list of console port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsolePortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-ports/{id}/: + get: + operationId: dcim_console_ports_retrieve + description: Get a console port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePort' + description: '' + put: + operationId: dcim_console_ports_update + description: Put a console port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableConsolePortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableConsolePortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePort' + description: '' + patch: + operationId: dcim_console_ports_partial_update + description: Patch a console port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableConsolePortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableConsolePortRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePort' + description: '' + delete: + operationId: dcim_console_ports_destroy + description: Delete a console port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-ports/{id}/trace/: + get: + operationId: dcim_console_ports_trace_retrieve + description: Trace a complete cable path and return each segment as a three-tuple + of (termination, cable, termination). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsolePort' + description: '' + /api/dcim/console-server-port-templates/: + get: + operationId: dcim_console_server_port_templates_list + description: Get a list of console server port template objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + enum: + - Other + - Serial + - USB + - 'null' + description: |- + * `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')] + * `Other` - [('other', 'Other')] + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__n + schema: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + enum: + - Other + - Serial + - USB + - 'null' + description: |- + * `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')] + * `Other` - [('other', 'Other')] + - in: query + name: type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConsoleServerPortTemplateList' + description: '' + post: + operationId: dcim_console_server_port_templates_create + description: Post a list of console server port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPortTemplate' + description: '' + put: + operationId: dcim_console_server_port_templates_bulk_update + description: Put a list of console server port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplate' + description: '' + patch: + operationId: dcim_console_server_port_templates_bulk_partial_update + description: Patch a list of console server port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplate' + description: '' + delete: + operationId: dcim_console_server_port_templates_bulk_destroy + description: Delete a list of console server port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-server-port-templates/{id}/: + get: + operationId: dcim_console_server_port_templates_retrieve + description: Get a console server port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPortTemplate' + description: '' + put: + operationId: dcim_console_server_port_templates_update + description: Put a console server port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPortTemplate' + description: '' + patch: + operationId: dcim_console_server_port_templates_partial_update + description: Patch a console server port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPortTemplate' + description: '' + delete: + operationId: dcim_console_server_port_templates_destroy + description: Delete a console server port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-server-ports/: + get: + operationId: dcim_console_server_ports_list + description: Get a list of console server port objects. + parameters: + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: connected + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: speed + schema: + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + enum: + - 115200 + - 1200 + - 19200 + - 2400 + - 38400 + - 4800 + - 57600 + - 9600 + - 'null' + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + - in: query + name: speed__ic + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__ie + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__iew + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__iregex + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__isw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__n + schema: + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + enum: + - 115200 + - 1200 + - 19200 + - 2400 + - 38400 + - 4800 + - 57600 + - 9600 + - 'null' + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + - in: query + name: speed__nic + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__nie + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__niew + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__nisw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: speed__regex + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConsoleServerPortList' + description: '' + post: + operationId: dcim_console_server_ports_create + description: Post a list of console server port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsoleServerPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsoleServerPortRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableConsoleServerPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableConsoleServerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPort' + description: '' + put: + operationId: dcim_console_server_ports_bulk_update + description: Put a list of console server port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPort' + description: '' + patch: + operationId: dcim_console_server_ports_bulk_partial_update + description: Patch a list of console server port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPort' + description: '' + delete: + operationId: dcim_console_server_ports_bulk_destroy + description: Delete a list of console server port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-server-ports/{id}/: + get: + operationId: dcim_console_server_ports_retrieve + description: Get a console server port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPort' + description: '' + put: + operationId: dcim_console_server_ports_update + description: Put a console server port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableConsoleServerPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableConsoleServerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPort' + description: '' + patch: + operationId: dcim_console_server_ports_partial_update + description: Patch a console server port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableConsoleServerPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableConsoleServerPortRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPort' + description: '' + delete: + operationId: dcim_console_server_ports_destroy + description: Delete a console server port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/console-server-ports/{id}/trace/: + get: + operationId: dcim_console_server_ports_trace_retrieve + description: Trace a complete cable path and return each segment as a three-tuple + of (termination, cable, termination). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this console server port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConsoleServerPort' + description: '' + /api/dcim/device-bay-templates/: + get: + operationId: dcim_device_bay_templates_list + description: Get a list of device bay template objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeviceBayTemplateList' + description: '' + post: + operationId: dcim_device_bay_templates_create + description: Post a list of device bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DeviceBayTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/DeviceBayTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBayTemplate' + description: '' + put: + operationId: dcim_device_bay_templates_bulk_update + description: Put a list of device bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplate' + description: '' + patch: + operationId: dcim_device_bay_templates_bulk_partial_update + description: Patch a list of device bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplate' + description: '' + delete: + operationId: dcim_device_bay_templates_bulk_destroy + description: Delete a list of device bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/device-bay-templates/{id}/: + get: + operationId: dcim_device_bay_templates_retrieve + description: Get a device bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBayTemplate' + description: '' + put: + operationId: dcim_device_bay_templates_update + description: Put a device bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeviceBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBayTemplate' + description: '' + patch: + operationId: dcim_device_bay_templates_partial_update + description: Patch a device bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedDeviceBayTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedDeviceBayTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBayTemplate' + description: '' + delete: + operationId: dcim_device_bay_templates_destroy + description: Delete a device bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/device-bays/: + get: + operationId: dcim_device_bays_list + description: Get a list of device bay objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: installed_device + schema: + type: array + items: + type: string + nullable: true + description: Installed device (name) + explode: true + style: form + - in: query + name: installed_device__n + schema: + type: array + items: + type: string + nullable: true + description: Installed device (name) + explode: true + style: form + - in: query + name: installed_device_id + schema: + type: array + items: + type: integer + nullable: true + description: Installed device (ID) + explode: true + style: form + - in: query + name: installed_device_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Installed device (ID) + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeviceBayList' + description: '' + post: + operationId: dcim_device_bays_create + description: Post a list of device bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DeviceBayRequest' + - type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/DeviceBayRequest' + - type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBay' + description: '' + put: + operationId: dcim_device_bays_bulk_update + description: Put a list of device bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBay' + description: '' + patch: + operationId: dcim_device_bays_bulk_partial_update + description: Patch a list of device bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBay' + description: '' + delete: + operationId: dcim_device_bays_bulk_destroy + description: Delete a list of device bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/device-bays/{id}/: + get: + operationId: dcim_device_bays_retrieve + description: Get a device bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBay' + description: '' + put: + operationId: dcim_device_bays_update + description: Put a device bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBayRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/DeviceBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBay' + description: '' + patch: + operationId: dcim_device_bays_partial_update + description: Patch a device bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedDeviceBayRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedDeviceBayRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceBay' + description: '' + delete: + operationId: dcim_device_bays_destroy + description: Delete a device bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device bay. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/device-roles/: + get: + operationId: dcim_device_roles_list + description: Get a list of device role objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: config_template_id + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: config_template_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + description: Parent device role (slug) + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + description: Parent device role (slug) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent device role (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent device role (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vm_role + schema: + type: boolean + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeviceRoleList' + description: '' + post: + operationId: dcim_device_roles_create + description: Post a list of device role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDeviceRoleRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDeviceRoleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDeviceRoleRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDeviceRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceRole' + description: '' + put: + operationId: dcim_device_roles_bulk_update + description: Put a list of device role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRole' + description: '' + patch: + operationId: dcim_device_roles_bulk_partial_update + description: Patch a list of device role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRole' + description: '' + delete: + operationId: dcim_device_roles_bulk_destroy + description: Delete a list of device role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/device-roles/{id}/: + get: + operationId: dcim_device_roles_retrieve + description: Get a device role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device role. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceRole' + description: '' + put: + operationId: dcim_device_roles_update + description: Put a device role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device role. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableDeviceRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableDeviceRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceRole' + description: '' + patch: + operationId: dcim_device_roles_partial_update + description: Patch a device role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device role. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableDeviceRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableDeviceRoleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceRole' + description: '' + delete: + operationId: dcim_device_roles_destroy + description: Delete a device role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device role. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/device-types/: + get: + operationId: dcim_device_types_list + description: Get a list of device type objects. + parameters: + - in: query + name: airflow + schema: + type: string + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + enum: + - bottom-to-top + - front-to-rear + - left-to-right + - mixed + - 'null' + - passive + - rear-to-front + - rear-to-side + - right-to-left + - side-to-rear + - top-to-bottom + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + - in: query + name: airflow__empty + schema: + type: boolean + - in: query + name: airflow__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__n + schema: + type: string + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + enum: + - bottom-to-top + - front-to-rear + - left-to-right + - mixed + - 'null' + - passive + - rear-to-front + - rear-to-side + - right-to-left + - side-to-rear + - top-to-bottom + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + - in: query + name: airflow__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: console_port_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_template_count__empty + schema: + type: boolean + - in: query + name: console_port_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_ports + schema: + type: boolean + description: Has console ports + - in: query + name: console_server_port_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_template_count__empty + schema: + type: boolean + - in: query + name: console_server_port_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_ports + schema: + type: boolean + description: Has console server ports + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: default_platform + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: default_platform__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: default_platform_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: default_platform_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_bay_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_template_count__empty + schema: + type: boolean + - in: query + name: device_bay_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bays + schema: + type: boolean + description: Has device bays + - in: query + name: device_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_count__empty + schema: + type: boolean + - in: query + name: device_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: exclude_from_utilization + schema: + type: boolean + - in: query + name: front_port_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_template_count__empty + schema: + type: boolean + - in: query + name: front_port_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: has_front_image + schema: + type: boolean + description: Has a front image + - in: query + name: has_rear_image + schema: + type: boolean + description: Has a rear image + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_template_count__empty + schema: + type: boolean + - in: query + name: interface_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interfaces + schema: + type: boolean + description: Has interfaces + - in: query + name: inventory_item_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_template_count__empty + schema: + type: boolean + - in: query + name: inventory_item_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_items + schema: + type: boolean + description: Has inventory items + - in: query + name: is_full_depth + schema: + type: boolean + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: model + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__empty + schema: + type: boolean + - in: query + name: model__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_bay_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_template_count__empty + schema: + type: boolean + - in: query + name: module_bay_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bays + schema: + type: boolean + description: Has module bays + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: part_number + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__empty + schema: + type: boolean + - in: query + name: part_number__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pass_through_ports + schema: + type: boolean + description: Has pass-through ports + - in: query + name: power_outlet_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_template_count__empty + schema: + type: boolean + - in: query + name: power_outlet_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlets + schema: + type: boolean + description: Has power outlets + - in: query + name: power_port_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_template_count__empty + schema: + type: boolean + - in: query + name: power_port_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_ports + schema: + type: boolean + description: Has power ports + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rear_port_template_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_template_count__empty + schema: + type: boolean + - in: query + name: rear_port_template_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_template_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_template_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_template_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_template_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: subdevice_role + schema: + type: string + x-spec-enum-id: 65a61d5e1deb4a24 + nullable: true + title: Parent/child status + enum: + - child + - 'null' + - parent + description: |- + Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. + + * `parent` - Parent + * `child` - Child + - in: query + name: subdevice_role__empty + schema: + type: boolean + - in: query + name: subdevice_role__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__n + schema: + type: string + x-spec-enum-id: 65a61d5e1deb4a24 + nullable: true + title: Parent/child status + enum: + - child + - 'null' + - parent + description: |- + Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. + + * `parent` - Parent + * `child` - Child + - in: query + name: subdevice_role__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: subdevice_role__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: u_height + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: u_height__empty + schema: + type: boolean + - in: query + name: u_height__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: u_height__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: u_height__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: u_height__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: u_height__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight_unit + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__empty + schema: + type: boolean + - in: query + name: weight_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__n + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeviceTypeList' + description: '' + post: + operationId: dcim_device_types_create + description: Post a list of device type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDeviceTypeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDeviceTypeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDeviceTypeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDeviceTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceType' + description: '' + put: + operationId: dcim_device_types_bulk_update + description: Put a list of device type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceType' + description: '' + patch: + operationId: dcim_device_types_bulk_partial_update + description: Patch a list of device type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceType' + description: '' + delete: + operationId: dcim_device_types_bulk_destroy + description: Delete a list of device type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/device-types/{id}/: + get: + operationId: dcim_device_types_retrieve + description: Get a device type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device type. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceType' + description: '' + put: + operationId: dcim_device_types_update + description: Put a device type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device type. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableDeviceTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableDeviceTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceType' + description: '' + patch: + operationId: dcim_device_types_partial_update + description: Patch a device type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device type. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableDeviceTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableDeviceTypeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceType' + description: '' + delete: + operationId: dcim_device_types_destroy + description: Delete a device type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device type. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/devices/: + get: + operationId: dcim_devices_list + description: Get a list of device objects. + parameters: + - in: query + name: airflow + schema: + type: string + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + enum: + - bottom-to-top + - front-to-rear + - left-to-right + - mixed + - 'null' + - passive + - rear-to-front + - rear-to-side + - right-to-left + - side-to-rear + - top-to-bottom + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + - in: query + name: airflow__empty + schema: + type: boolean + - in: query + name: airflow__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__n + schema: + type: string + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + enum: + - bottom-to-top + - front-to-rear + - left-to-right + - mixed + - 'null' + - passive + - rear-to-front + - rear-to-side + - right-to-left + - side-to-rear + - top-to-bottom + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + - in: query + name: airflow__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__empty + schema: + type: boolean + - in: query + name: asset_tag__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cluster_group + schema: + type: array + items: + type: string + description: Cluster group (slug) + explode: true + style: form + - in: query + name: cluster_group__n + schema: + type: array + items: + type: string + description: Cluster group (slug) + explode: true + style: form + - in: query + name: cluster_group_id + schema: + type: array + items: + type: integer + description: Cluster group (ID) + explode: true + style: form + - in: query + name: cluster_group_id__n + schema: + type: array + items: + type: integer + description: Cluster group (ID) + explode: true + style: form + - in: query + name: cluster_id + schema: + type: array + items: + type: integer + nullable: true + description: VM cluster (ID) + explode: true + style: form + - in: query + name: cluster_id__n + schema: + type: array + items: + type: integer + nullable: true + description: VM cluster (ID) + explode: true + style: form + - in: query + name: config_template_id + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: config_template_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: console_port_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_count__empty + schema: + type: boolean + - in: query + name: console_port_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_port_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_ports + schema: + type: boolean + description: Has console ports + - in: query + name: console_server_port_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_count__empty + schema: + type: boolean + - in: query + name: console_server_port_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_port_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: console_server_ports + schema: + type: boolean + description: Has console server ports + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_bay_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_count__empty + schema: + type: boolean + - in: query + name: device_bay_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bay_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: device_bays + schema: + type: boolean + description: Has device bays + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (slug) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (slug) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: face + schema: + type: string + x-spec-enum-id: d2fb9b3f75158b83 + nullable: true + title: Rack face + enum: + - front + - 'null' + - rear + description: |- + * `front` - Front + * `rear` - Rear + - in: query + name: face__empty + schema: + type: boolean + - in: query + name: face__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__n + schema: + type: string + x-spec-enum-id: d2fb9b3f75158b83 + nullable: true + title: Rack face + enum: + - front + - 'null' + - rear + description: |- + * `front` - Front + * `rear` - Rear + - in: query + name: face__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: face__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: front_port_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_count__empty + schema: + type: boolean + - in: query + name: front_port_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: front_port_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: has_oob_ip + schema: + type: boolean + description: Has an out-of-band IP + - in: query + name: has_primary_ip + schema: + type: boolean + description: Has a primary IP + - in: query + name: has_virtual_device_context + schema: + type: boolean + description: Has virtual device context + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__empty + schema: + type: boolean + - in: query + name: interface_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interfaces + schema: + type: boolean + description: Has interfaces + - in: query + name: inventory_item_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_count__empty + schema: + type: boolean + - in: query + name: inventory_item_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: inventory_item_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: is_full_depth + schema: + type: boolean + description: Is full depth + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: latitude + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__empty + schema: + type: boolean + - in: query + name: latitude__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: local_context_data + schema: + type: boolean + description: Has local config context data + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: longitude + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__empty + schema: + type: boolean + - in: query + name: longitude__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: mac_address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: model + schema: + type: array + items: + type: string + description: Device model (slug) + explode: true + style: form + - in: query + name: model__n + schema: + type: array + items: + type: string + description: Device model (slug) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_bay_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_count__empty + schema: + type: boolean + - in: query + name: module_bay_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bay_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_bays + schema: + type: boolean + description: Has module bays + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - in: query + name: oob_ip_id + schema: + type: array + items: + type: integer + description: OOB IP (ID) + explode: true + style: form + - in: query + name: oob_ip_id__n + schema: + type: array + items: + type: integer + description: OOB IP (ID) + explode: true + style: form + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent_bay_id + schema: + type: array + items: + type: integer + description: Parent bay (ID) + explode: true + style: form + - in: query + name: parent_bay_id__n + schema: + type: array + items: + type: integer + description: Parent bay (ID) + explode: true + style: form + - in: query + name: parent_device_id + schema: + type: array + items: + type: integer + description: Parent Device (ID) + explode: true + style: form + - in: query + name: parent_device_id__n + schema: + type: array + items: + type: integer + description: Parent Device (ID) + explode: true + style: form + - in: query + name: pass_through_ports + schema: + type: boolean + description: Has pass-through ports + - in: query + name: platform + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: platform__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: platform_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: platform_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: position__empty + schema: + type: boolean + - in: query + name: position__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: position__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: position__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: position__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: position__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: power_outlet_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_count__empty + schema: + type: boolean + - in: query + name: power_outlet_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlet_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_outlets + schema: + type: boolean + description: Has power outlets + - in: query + name: power_port_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_count__empty + schema: + type: boolean + - in: query + name: power_port_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_port_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: power_ports + schema: + type: boolean + description: Has power ports + - in: query + name: primary_ip4 + schema: + type: array + items: + type: string + description: Primary IPv4 (address) + explode: true + style: form + - in: query + name: primary_ip4__n + schema: + type: array + items: + type: string + description: Primary IPv4 (address) + explode: true + style: form + - in: query + name: primary_ip4_id + schema: + type: array + items: + type: integer + description: Primary IPv4 (ID) + explode: true + style: form + - in: query + name: primary_ip4_id__n + schema: + type: array + items: + type: integer + description: Primary IPv4 (ID) + explode: true + style: form + - in: query + name: primary_ip6 + schema: + type: array + items: + type: string + description: Primary IPv6 (address) + explode: true + style: form + - in: query + name: primary_ip6__n + schema: + type: array + items: + type: string + description: Primary IPv6 (address) + explode: true + style: form + - in: query + name: primary_ip6_id + schema: + type: array + items: + type: integer + description: Primary IPv6 (ID) + explode: true + style: form + - in: query + name: primary_ip6_id__n + schema: + type: array + items: + type: integer + description: Primary IPv6 (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rear_port_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_count__empty + schema: + type: boolean + - in: query + name: rear_port_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rear_port_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__empty + schema: + type: boolean + - in: query + name: serial__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vc_position + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_position__empty + schema: + type: boolean + - in: query + name: vc_position__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_position__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_position__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_position__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_position__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_priority + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_priority__empty + schema: + type: boolean + - in: query + name: vc_priority__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_priority__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_priority__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_priority__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vc_priority__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_member + schema: + type: boolean + description: Is a virtual chassis member + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDeviceWithConfigContextList' + description: '' + post: + operationId: dcim_devices_create + description: Post a list of device objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + - type: array + items: + $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceWithConfigContext' + description: '' + put: + operationId: dcim_devices_bulk_update + description: Put a list of device objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContext' + description: '' + patch: + operationId: dcim_devices_bulk_partial_update + description: Patch a list of device objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContext' + description: '' + delete: + operationId: dcim_devices_bulk_destroy + description: Delete a list of device objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/devices/{id}/: + get: + operationId: dcim_devices_retrieve + description: Get a device object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceWithConfigContext' + description: '' + put: + operationId: dcim_devices_update + description: Put a device object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceWithConfigContext' + description: '' + patch: + operationId: dcim_devices_partial_update + description: Patch a device object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContextRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceWithConfigContext' + description: '' + delete: + operationId: dcim_devices_destroy + description: Delete a device object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/devices/{id}/render-config/: + post: + operationId: dcim_devices_render_config_create + description: Resolve and render the preferred ConfigTemplate for this Device + or Virtual Machine. + parameters: + - in: query + name: format + schema: + type: string + enum: + - json + - txt + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this device. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceWithConfigContext' + text/plain: + schema: + $ref: '#/components/schemas/DeviceWithConfigContext' + description: '' + /api/dcim/front-port-templates/: + get: + operationId: dcim_front_port_templates_list + description: Get a list of front port template objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: positions + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__empty + schema: + type: boolean + - in: query + name: positions__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rear_port_id + schema: + type: array + items: + type: integer + description: Rear port (ID) + explode: true + style: form + - in: query + name: rear_port_id__n + schema: + type: array + items: + type: integer + description: Rear port (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedFrontPortTemplateList' + description: '' + post: + operationId: dcim_front_port_templates_create + description: Post a list of front port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableFrontPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableFrontPortTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableFrontPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableFrontPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPortTemplate' + description: '' + put: + operationId: dcim_front_port_templates_bulk_update + description: Put a list of front port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplate' + description: '' + patch: + operationId: dcim_front_port_templates_bulk_partial_update + description: Patch a list of front port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplate' + description: '' + delete: + operationId: dcim_front_port_templates_bulk_destroy + description: Delete a list of front port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/front-port-templates/{id}/: + get: + operationId: dcim_front_port_templates_retrieve + description: Get a front port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPortTemplate' + description: '' + put: + operationId: dcim_front_port_templates_update + description: Put a front port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableFrontPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableFrontPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPortTemplate' + description: '' + patch: + operationId: dcim_front_port_templates_partial_update + description: Patch a front port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableFrontPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableFrontPortTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPortTemplate' + description: '' + delete: + operationId: dcim_front_port_templates_destroy + description: Delete a front port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/front-ports/: + get: + operationId: dcim_front_ports_list + description: Get a list of front port objects. + parameters: + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: positions + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__empty + schema: + type: boolean + - in: query + name: positions__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rear_port_id + schema: + type: array + items: + type: integer + description: Rear port (ID) + explode: true + style: form + - in: query + name: rear_port_id__n + schema: + type: array + items: + type: integer + description: Rear port (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedFrontPortList' + description: '' + post: + operationId: dcim_front_ports_create + description: Post a list of front port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableFrontPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableFrontPortRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableFrontPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableFrontPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPort' + description: '' + put: + operationId: dcim_front_ports_bulk_update + description: Put a list of front port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPort' + description: '' + patch: + operationId: dcim_front_ports_bulk_partial_update + description: Patch a list of front port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPort' + description: '' + delete: + operationId: dcim_front_ports_bulk_destroy + description: Delete a list of front port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FrontPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/front-ports/{id}/: + get: + operationId: dcim_front_ports_retrieve + description: Get a front port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPort' + description: '' + put: + operationId: dcim_front_ports_update + description: Put a front port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableFrontPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableFrontPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPort' + description: '' + patch: + operationId: dcim_front_ports_partial_update + description: Patch a front port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableFrontPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableFrontPortRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPort' + description: '' + delete: + operationId: dcim_front_ports_destroy + description: Delete a front port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/front-ports/{id}/paths/: + get: + operationId: dcim_front_ports_paths_retrieve + description: Return all CablePaths which traverse a given pass-through port. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this front port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontPort' + description: '' + /api/dcim/interface-templates/: + get: + operationId: dcim_interface_templates_list + description: Get a list of interface template objects. + parameters: + - in: query + name: bridge_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: bridge_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mgmt_only + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: poe_mode + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__empty + schema: + type: boolean + - in: query + name: poe_mode__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__n + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_type + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__empty + schema: + type: boolean + - in: query + name: poe_type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rf_role + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__empty + schema: + type: boolean + - in: query + name: rf_role__ic + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__ie + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__iew + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__isw + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__n + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__nic + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__nie + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__niew + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__regex + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInterfaceTemplateList' + description: '' + post: + operationId: dcim_interface_templates_create + description: Post a list of interface template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableInterfaceTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableInterfaceTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableInterfaceTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableInterfaceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceTemplate' + description: '' + put: + operationId: dcim_interface_templates_bulk_update + description: Put a list of interface template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplate' + description: '' + patch: + operationId: dcim_interface_templates_bulk_partial_update + description: Patch a list of interface template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplate' + description: '' + delete: + operationId: dcim_interface_templates_bulk_destroy + description: Delete a list of interface template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/interface-templates/{id}/: + get: + operationId: dcim_interface_templates_retrieve + description: Get a interface template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceTemplate' + description: '' + put: + operationId: dcim_interface_templates_update + description: Put a interface template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableInterfaceTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableInterfaceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceTemplate' + description: '' + patch: + operationId: dcim_interface_templates_partial_update + description: Patch a interface template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableInterfaceTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableInterfaceTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InterfaceTemplate' + description: '' + delete: + operationId: dcim_interface_templates_destroy + description: Delete a interface template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/interfaces/: + get: + operationId: dcim_interfaces_list + description: Get a list of interface objects. + parameters: + - in: query + name: bridge_id + schema: + type: array + items: + type: integer + description: Bridged interface (ID) + explode: true + style: form + - in: query + name: bridge_id__n + schema: + type: array + items: + type: integer + description: Bridged interface (ID) + explode: true + style: form + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: connected + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: duplex + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__empty + schema: + type: boolean + - in: query + name: duplex__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__n + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: duplex__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 368458a2b67c916b + nullable: true + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: kind + schema: + type: string + description: Kind of interface + - in: query + name: l2vpn + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: L2VPN + explode: true + style: form + - in: query + name: l2vpn__n + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: L2VPN + explode: true + style: form + - in: query + name: l2vpn_id + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: l2vpn_id__n + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: lag_id + schema: + type: array + items: + type: integer + description: LAG interface (ID) + explode: true + style: form + - in: query + name: lag_id__n + schema: + type: array + items: + type: integer + description: LAG interface (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: mac_address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: mgmt_only + schema: + type: boolean + - in: query + name: mode + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__empty + schema: + type: boolean + description: 802.1Q Mode + - in: query + name: mode__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__n + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: mtu + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__empty + schema: + type: boolean + - in: query + name: mtu__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + description: Parent interface (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + description: Parent interface (ID) + explode: true + style: form + - in: query + name: poe_mode + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__empty + schema: + type: boolean + - in: query + name: poe_mode__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__n + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_mode__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + explode: true + style: form + - in: query + name: poe_type + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__empty + schema: + type: boolean + - in: query + name: poe_type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: poe_type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 5473d57885f237ab + nullable: true + explode: true + style: form + - in: query + name: primary_mac_address + schema: + type: array + items: + type: string + description: Primary MAC address + explode: true + style: form + - in: query + name: primary_mac_address__n + schema: + type: array + items: + type: string + description: Primary MAC address + explode: true + style: form + - in: query + name: primary_mac_address_id + schema: + type: array + items: + type: integer + description: Primary MAC address (ID) + explode: true + style: form + - in: query + name: primary_mac_address_id__n + schema: + type: array + items: + type: integer + description: Primary MAC address (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rf_channel + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__empty + schema: + type: boolean + - in: query + name: rf_channel__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__n + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + explode: true + style: form + - in: query + name: rf_channel_frequency + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_frequency__empty + schema: + type: boolean + - in: query + name: rf_channel_frequency__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_frequency__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_frequency__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_frequency__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_frequency__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_width + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_width__empty + schema: + type: boolean + - in: query + name: rf_channel_width__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_width__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_width__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_width__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_channel_width__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: rf_role + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__empty + schema: + type: boolean + - in: query + name: rf_role__ic + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__ie + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__iew + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__isw + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__n + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__nic + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__nie + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__niew + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: rf_role__regex + schema: + type: array + items: + type: string + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: speed + schema: + type: array + items: + type: integer + format: int64 + explode: true + style: form + - in: query + name: speed__empty + schema: + type: array + items: + type: integer + format: int64 + explode: true + style: form + - in: query + name: speed__gt + schema: + type: array + items: + type: integer + format: int64 + explode: true + style: form + - in: query + name: speed__gte + schema: + type: array + items: + type: integer + format: int64 + explode: true + style: form + - in: query + name: speed__lt + schema: + type: array + items: + type: integer + format: int64 + explode: true + style: form + - in: query + name: speed__lte + schema: + type: array + items: + type: integer + format: int64 + explode: true + style: form + - in: query + name: speed__n + schema: + type: array + items: + type: integer + format: int64 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tx_power + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tx_power__empty + schema: + type: boolean + - in: query + name: tx_power__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tx_power__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tx_power__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tx_power__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tx_power__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: b067eb1f050c6ae9 + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vdc + schema: + type: array + items: + type: string + description: Virtual Device Context + explode: true + style: form + - in: query + name: vdc__n + schema: + type: array + items: + type: string + description: Virtual Device Context + explode: true + style: form + - in: query + name: vdc_id + schema: + type: array + items: + type: integer + description: Virtual Device Context + explode: true + style: form + - in: query + name: vdc_id__n + schema: + type: array + items: + type: integer + description: Virtual Device Context + explode: true + style: form + - in: query + name: vdc_identifier + schema: + type: array + items: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Virtual Device Context (Identifier) + explode: true + style: form + - in: query + name: vdc_identifier__n + schema: + type: array + items: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Virtual Device Context (Identifier) + explode: true + style: form + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_member + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: virtual_chassis_member_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_chassis_member_or_master + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: virtual_chassis_member_or_master_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_circuit_id + schema: + type: array + items: + type: integer + description: Virtual circuit (ID) + explode: true + style: form + - in: query + name: virtual_circuit_id__n + schema: + type: array + items: + type: integer + description: Virtual circuit (ID) + explode: true + style: form + - in: query + name: virtual_circuit_termination_id + schema: + type: array + items: + type: integer + description: Virtual circuit termination (ID) + explode: true + style: form + - in: query + name: virtual_circuit_termination_id__n + schema: + type: array + items: + type: integer + description: Virtual circuit termination (ID) + explode: true + style: form + - in: query + name: vlan + schema: + type: string + description: Assigned VID + - in: query + name: vlan_id + schema: + type: string + description: Assigned VLAN + - in: query + name: vlan_translation_policy + schema: + type: array + items: + type: string + description: VLAN Translation Policy + explode: true + style: form + - in: query + name: vlan_translation_policy__n + schema: + type: array + items: + type: string + description: VLAN Translation Policy + explode: true + style: form + - in: query + name: vlan_translation_policy_id + schema: + type: array + items: + type: integer + description: VLAN Translation Policy (ID) + explode: true + style: form + - in: query + name: vlan_translation_policy_id__n + schema: + type: array + items: + type: integer + description: VLAN Translation Policy (ID) + explode: true + style: form + - in: query + name: vrf + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf__n + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf_id + schema: + type: array + items: + type: integer + description: VRF + explode: true + style: form + - in: query + name: vrf_id__n + schema: + type: array + items: + type: integer + description: VRF + explode: true + style: form + - in: query + name: wireless_lan_id + schema: + type: array + items: + type: integer + description: Wireless LAN + explode: true + style: form + - in: query + name: wireless_lan_id__n + schema: + type: array + items: + type: integer + description: Wireless LAN + explode: true + style: form + - in: query + name: wireless_link_id + schema: + type: array + items: + type: integer + nullable: true + description: Wireless link + explode: true + style: form + - in: query + name: wireless_link_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Wireless link + explode: true + style: form + - in: query + name: wwn + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: wwn__regex + schema: + type: array + items: + type: string + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInterfaceList' + description: '' + post: + operationId: dcim_interfaces_create + description: Post a list of interface objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableInterfaceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableInterfaceRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableInterfaceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableInterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Interface' + description: '' + put: + operationId: dcim_interfaces_bulk_update + description: Put a list of interface objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Interface' + description: '' + patch: + operationId: dcim_interfaces_bulk_partial_update + description: Patch a list of interface objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Interface' + description: '' + delete: + operationId: dcim_interfaces_bulk_destroy + description: Delete a list of interface objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/interfaces/{id}/: + get: + operationId: dcim_interfaces_retrieve + description: Get a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Interface' + description: '' + put: + operationId: dcim_interfaces_update + description: Put a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableInterfaceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableInterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Interface' + description: '' + patch: + operationId: dcim_interfaces_partial_update + description: Patch a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableInterfaceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableInterfaceRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Interface' + description: '' + delete: + operationId: dcim_interfaces_destroy + description: Delete a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/interfaces/{id}/trace/: + get: + operationId: dcim_interfaces_trace_retrieve + description: Trace a complete cable path and return each segment as a three-tuple + of (termination, cable, termination). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Interface' + description: '' + /api/dcim/inventory-item-roles/: + get: + operationId: dcim_inventory_item_roles_list + description: Get a list of inventory item role objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInventoryItemRoleList' + description: '' + post: + operationId: dcim_inventory_item_roles_create + description: Post a list of inventory item role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/InventoryItemRoleRequest' + - type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/InventoryItemRoleRequest' + - type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemRole' + description: '' + put: + operationId: dcim_inventory_item_roles_bulk_update + description: Put a list of inventory item role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRole' + description: '' + patch: + operationId: dcim_inventory_item_roles_bulk_partial_update + description: Patch a list of inventory item role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRole' + description: '' + delete: + operationId: dcim_inventory_item_roles_bulk_destroy + description: Delete a list of inventory item role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/inventory-item-roles/{id}/: + get: + operationId: dcim_inventory_item_roles_retrieve + description: Get a inventory item role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item role. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemRole' + description: '' + put: + operationId: dcim_inventory_item_roles_update + description: Put a inventory item role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item role. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/InventoryItemRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemRole' + description: '' + patch: + operationId: dcim_inventory_item_roles_partial_update + description: Patch a inventory item role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item role. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedInventoryItemRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedInventoryItemRoleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemRole' + description: '' + delete: + operationId: dcim_inventory_item_roles_destroy + description: Delete a inventory item role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item role. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/inventory-item-templates/: + get: + operationId: dcim_inventory_item_templates_list + description: Get a list of inventory item template objects. + parameters: + - in: query + name: component_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__empty + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: component_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + nullable: true + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent inventory item (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent inventory item (ID) + explode: true + style: form + - in: query + name: part_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__empty + schema: + type: boolean + - in: query + name: part_id__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInventoryItemTemplateList' + description: '' + post: + operationId: dcim_inventory_item_templates_create + description: Post a list of inventory item template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/InventoryItemTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/InventoryItemTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemTemplate' + description: '' + put: + operationId: dcim_inventory_item_templates_bulk_update + description: Put a list of inventory item template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplate' + description: '' + patch: + operationId: dcim_inventory_item_templates_bulk_partial_update + description: Patch a list of inventory item template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplate' + description: '' + delete: + operationId: dcim_inventory_item_templates_bulk_destroy + description: Delete a list of inventory item template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/inventory-item-templates/{id}/: + get: + operationId: dcim_inventory_item_templates_retrieve + description: Get a inventory item template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemTemplate' + description: '' + put: + operationId: dcim_inventory_item_templates_update + description: Put a inventory item template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/InventoryItemTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemTemplate' + description: '' + patch: + operationId: dcim_inventory_item_templates_partial_update + description: Patch a inventory item template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedInventoryItemTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedInventoryItemTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItemTemplate' + description: '' + delete: + operationId: dcim_inventory_item_templates_destroy + description: Delete a inventory item template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/inventory-items/: + get: + operationId: dcim_inventory_items_list + description: Get a list of inventory item objects. + parameters: + - in: query + name: asset_tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__empty + schema: + type: boolean + - in: query + name: asset_tag__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: component_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__empty + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: component_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: component_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: discovered + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + nullable: true + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent inventory item (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent inventory item (ID) + explode: true + style: form + - in: query + name: part_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__empty + schema: + type: boolean + - in: query + name: part_id__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_id__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: serial + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__empty + schema: + type: boolean + - in: query + name: serial__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInventoryItemList' + description: '' + post: + operationId: dcim_inventory_items_create + description: Post a list of inventory item objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableInventoryItemRequest' + - type: array + items: + $ref: '#/components/schemas/WritableInventoryItemRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableInventoryItemRequest' + - type: array + items: + $ref: '#/components/schemas/WritableInventoryItemRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + description: '' + put: + operationId: dcim_inventory_items_bulk_update + description: Put a list of inventory item objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItem' + description: '' + patch: + operationId: dcim_inventory_items_bulk_partial_update + description: Patch a list of inventory item objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItem' + description: '' + delete: + operationId: dcim_inventory_items_bulk_destroy + description: Delete a list of inventory item objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/InventoryItemRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/inventory-items/{id}/: + get: + operationId: dcim_inventory_items_retrieve + description: Get a inventory item object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + description: '' + put: + operationId: dcim_inventory_items_update + description: Put a inventory item object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableInventoryItemRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableInventoryItemRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + description: '' + patch: + operationId: dcim_inventory_items_partial_update + description: Patch a inventory item object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableInventoryItemRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableInventoryItemRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryItem' + description: '' + delete: + operationId: dcim_inventory_items_destroy + description: Delete a inventory item object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inventory item. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/locations/: + get: + operationId: dcim_locations_list + description: Get a list of location objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__empty + schema: + type: boolean + - in: query + name: facility__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + description: Parent location (slug) + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + description: Parent location (slug) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent location (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent location (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedLocationList' + description: '' + post: + operationId: dcim_locations_create + description: Post a list of location objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableLocationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableLocationRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableLocationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableLocationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + description: '' + put: + operationId: dcim_locations_bulk_update + description: Put a list of location objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/LocationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Location' + description: '' + patch: + operationId: dcim_locations_bulk_partial_update + description: Patch a list of location objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/LocationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Location' + description: '' + delete: + operationId: dcim_locations_bulk_destroy + description: Delete a list of location objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/LocationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/locations/{id}/: + get: + operationId: dcim_locations_retrieve + description: Get a location object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this location. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + description: '' + put: + operationId: dcim_locations_update + description: Put a location object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this location. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableLocationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableLocationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + description: '' + patch: + operationId: dcim_locations_partial_update + description: Patch a location object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this location. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableLocationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableLocationRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + description: '' + delete: + operationId: dcim_locations_destroy + description: Delete a location object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this location. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/mac-addresses/: + get: + operationId: dcim_mac_addresses_list + description: Get a list of MAC address objects. + parameters: + - in: query + name: assigned + schema: + type: boolean + description: Is assigned + - in: query + name: assigned_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__empty + schema: + type: boolean + - in: query + name: assigned_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface__n + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mac_address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: primary + schema: + type: boolean + description: Is primary + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: virtual_machine_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vminterface + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface__n + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface_id + schema: + type: array + items: + type: integer + description: VM interface (ID) + explode: true + style: form + - in: query + name: vminterface_id__n + schema: + type: array + items: + type: integer + description: VM interface (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedMACAddressList' + description: '' + post: + operationId: dcim_mac_addresses_create + description: Post a list of MAC address objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MACAddressRequest' + - type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/MACAddressRequest' + - type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/MACAddress' + description: '' + put: + operationId: dcim_mac_addresses_bulk_update + description: Put a list of MAC address objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddress' + description: '' + patch: + operationId: dcim_mac_addresses_bulk_partial_update + description: Patch a list of MAC address objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddress' + description: '' + delete: + operationId: dcim_mac_addresses_bulk_destroy + description: Delete a list of MAC address objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/MACAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/mac-addresses/{id}/: + get: + operationId: dcim_mac_addresses_retrieve + description: Get a MAC address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this MAC address. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MACAddress' + description: '' + put: + operationId: dcim_mac_addresses_update + description: Put a MAC address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this MAC address. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MACAddressRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/MACAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MACAddress' + description: '' + patch: + operationId: dcim_mac_addresses_partial_update + description: Patch a MAC address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this MAC address. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedMACAddressRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedMACAddressRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MACAddress' + description: '' + delete: + operationId: dcim_mac_addresses_destroy + description: Delete a MAC address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this MAC address. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/manufacturers/: + get: + operationId: dcim_manufacturers_list + description: Get a list of manufacturer objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedManufacturerList' + description: '' + post: + operationId: dcim_manufacturers_create + description: Post a list of manufacturer objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ManufacturerRequest' + - type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ManufacturerRequest' + - type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Manufacturer' + description: '' + put: + operationId: dcim_manufacturers_bulk_update + description: Put a list of manufacturer objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Manufacturer' + description: '' + patch: + operationId: dcim_manufacturers_bulk_partial_update + description: Patch a list of manufacturer objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Manufacturer' + description: '' + delete: + operationId: dcim_manufacturers_bulk_destroy + description: Delete a list of manufacturer objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ManufacturerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/manufacturers/{id}/: + get: + operationId: dcim_manufacturers_retrieve + description: Get a manufacturer object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this manufacturer. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Manufacturer' + description: '' + put: + operationId: dcim_manufacturers_update + description: Put a manufacturer object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this manufacturer. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManufacturerRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ManufacturerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Manufacturer' + description: '' + patch: + operationId: dcim_manufacturers_partial_update + description: Patch a manufacturer object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this manufacturer. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedManufacturerRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedManufacturerRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Manufacturer' + description: '' + delete: + operationId: dcim_manufacturers_destroy + description: Delete a manufacturer object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this manufacturer. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-bay-templates/: + get: + operationId: dcim_module_bay_templates_list + description: Get a list of module bay template objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: position + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__empty + schema: + type: boolean + - in: query + name: position__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleBayTemplateList' + description: '' + post: + operationId: dcim_module_bay_templates_create + description: Post a list of module bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ModuleBayTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ModuleBayTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBayTemplate' + description: '' + put: + operationId: dcim_module_bay_templates_bulk_update + description: Put a list of module bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplate' + description: '' + patch: + operationId: dcim_module_bay_templates_bulk_partial_update + description: Patch a list of module bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplate' + description: '' + delete: + operationId: dcim_module_bay_templates_bulk_destroy + description: Delete a list of module bay template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-bay-templates/{id}/: + get: + operationId: dcim_module_bay_templates_retrieve + description: Get a module bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBayTemplate' + description: '' + put: + operationId: dcim_module_bay_templates_update + description: Put a module bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleBayTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBayTemplate' + description: '' + patch: + operationId: dcim_module_bay_templates_partial_update + description: Patch a module bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleBayTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleBayTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBayTemplate' + description: '' + delete: + operationId: dcim_module_bay_templates_destroy + description: Delete a module bay template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-bays/: + get: + operationId: dcim_module_bays_list + description: Get a list of module bay objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: installed_module_id + schema: + type: array + items: + type: integer + description: Installed module (ID) + explode: true + style: form + - in: query + name: installed_module_id__n + schema: + type: array + items: + type: integer + description: Installed module (ID) + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent module bay (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent module bay (ID) + explode: true + style: form + - in: query + name: position + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__empty + schema: + type: boolean + - in: query + name: position__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: position__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleBayList' + description: '' + post: + operationId: dcim_module_bays_create + description: Post a list of module bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ModuleBayRequest' + - type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ModuleBayRequest' + - type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBay' + description: '' + put: + operationId: dcim_module_bays_bulk_update + description: Put a list of module bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBay' + description: '' + patch: + operationId: dcim_module_bays_bulk_partial_update + description: Patch a list of module bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBay' + description: '' + delete: + operationId: dcim_module_bays_bulk_destroy + description: Delete a list of module bay objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-bays/{id}/: + get: + operationId: dcim_module_bays_retrieve + description: Get a module bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBay' + description: '' + put: + operationId: dcim_module_bays_update + description: Put a module bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBayRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleBayRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBay' + description: '' + patch: + operationId: dcim_module_bays_partial_update + description: Patch a module bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleBayRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleBayRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleBay' + description: '' + delete: + operationId: dcim_module_bays_destroy + description: Delete a module bay object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module bay. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-type-profiles/: + get: + operationId: dcim_module_type_profiles_list + description: Get a list of module type profile objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleTypeProfileList' + description: '' + post: + operationId: dcim_module_type_profiles_create + description: Post a list of module type profile objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ModuleTypeProfileRequest' + - type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ModuleTypeProfileRequest' + - type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleTypeProfile' + description: '' + put: + operationId: dcim_module_type_profiles_bulk_update + description: Put a list of module type profile objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfile' + description: '' + patch: + operationId: dcim_module_type_profiles_bulk_partial_update + description: Patch a list of module type profile objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfile' + description: '' + delete: + operationId: dcim_module_type_profiles_bulk_destroy + description: Delete a list of module type profile objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-type-profiles/{id}/: + get: + operationId: dcim_module_type_profiles_retrieve + description: Get a module type profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type profile. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleTypeProfile' + description: '' + put: + operationId: dcim_module_type_profiles_update + description: Put a module type profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type profile. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleTypeProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleTypeProfile' + description: '' + patch: + operationId: dcim_module_type_profiles_partial_update + description: Patch a module type profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type profile. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleTypeProfileRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleTypeProfileRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleTypeProfile' + description: '' + delete: + operationId: dcim_module_type_profiles_destroy + description: Delete a module type profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type profile. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-types/: + get: + operationId: dcim_module_types_list + description: Get a list of module type objects. + parameters: + - in: query + name: airflow + schema: + type: string + x-spec-enum-id: 5ad4e700c656b09d + nullable: true + enum: + - front-to-rear + - left-to-right + - 'null' + - passive + - rear-to-front + - right-to-left + - side-to-rear + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `passive` - Passive + - in: query + name: airflow__empty + schema: + type: boolean + - in: query + name: airflow__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__n + schema: + type: string + x-spec-enum-id: 5ad4e700c656b09d + nullable: true + enum: + - front-to-rear + - left-to-right + - 'null' + - passive + - rear-to-front + - right-to-left + - side-to-rear + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `passive` - Passive + - in: query + name: airflow__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: console_ports + schema: + type: boolean + description: Has console ports + - in: query + name: console_server_ports + schema: + type: boolean + description: Has console server ports + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interfaces + schema: + type: boolean + description: Has interfaces + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: model + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__empty + schema: + type: boolean + - in: query + name: model__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_count__empty + schema: + type: boolean + - in: query + name: module_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: module_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: part_number + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__empty + schema: + type: boolean + - in: query + name: part_number__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: part_number__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: pass_through_ports + schema: + type: boolean + description: Has pass-through ports + - in: query + name: power_outlets + schema: + type: boolean + description: Has power outlets + - in: query + name: power_ports + schema: + type: boolean + description: Has power ports + - in: query + name: profile + schema: + type: array + items: + type: string + description: Profile (name) + explode: true + style: form + - in: query + name: profile__n + schema: + type: array + items: + type: string + description: Profile (name) + explode: true + style: form + - in: query + name: profile_id + schema: + type: array + items: + type: integer + nullable: true + description: Profile (ID) + explode: true + style: form + - in: query + name: profile_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Profile (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight_unit + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__empty + schema: + type: boolean + - in: query + name: weight_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__n + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleTypeList' + description: '' + post: + operationId: dcim_module_types_create + description: Post a list of module type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableModuleTypeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableModuleTypeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableModuleTypeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableModuleTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleType' + description: '' + put: + operationId: dcim_module_types_bulk_update + description: Put a list of module type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleType' + description: '' + patch: + operationId: dcim_module_types_bulk_partial_update + description: Patch a list of module type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleType' + description: '' + delete: + operationId: dcim_module_types_bulk_destroy + description: Delete a list of module type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/module-types/{id}/: + get: + operationId: dcim_module_types_retrieve + description: Get a module type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleType' + description: '' + put: + operationId: dcim_module_types_update + description: Put a module type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableModuleTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableModuleTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleType' + description: '' + patch: + operationId: dcim_module_types_partial_update + description: Patch a module type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableModuleTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableModuleTypeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleType' + description: '' + delete: + operationId: dcim_module_types_destroy + description: Delete a module type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module type. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/modules/: + get: + operationId: dcim_modules_list + description: Get a list of module objects. + parameters: + - in: query + name: asset_tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__empty + schema: + type: boolean + - in: query + name: asset_tag__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_bay_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: module_bay_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: module_type + schema: + type: array + items: + type: string + description: Module type (model) + explode: true + style: form + - in: query + name: module_type__n + schema: + type: array + items: + type: string + description: Module type (model) + explode: true + style: form + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + description: Module type (ID) + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: profile + schema: + type: array + items: + type: string + description: Profile (name) + explode: true + style: form + - in: query + name: profile__n + schema: + type: array + items: + type: string + description: Profile (name) + explode: true + style: form + - in: query + name: profile_id + schema: + type: array + items: + type: integer + description: Profile (ID) + explode: true + style: form + - in: query + name: profile_id__n + schema: + type: array + items: + type: integer + description: Profile (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__empty + schema: + type: boolean + - in: query + name: serial__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 545817eb4c4f2ae4 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleList' + description: '' + post: + operationId: dcim_modules_create + description: Post a list of module objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableModuleRequest' + - type: array + items: + $ref: '#/components/schemas/WritableModuleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableModuleRequest' + - type: array + items: + $ref: '#/components/schemas/WritableModuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Module' + description: '' + put: + operationId: dcim_modules_bulk_update + description: Put a list of module objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Module' + description: '' + patch: + operationId: dcim_modules_bulk_partial_update + description: Patch a list of module objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Module' + description: '' + delete: + operationId: dcim_modules_bulk_destroy + description: Delete a list of module objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ModuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/modules/{id}/: + get: + operationId: dcim_modules_retrieve + description: Get a module object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Module' + description: '' + put: + operationId: dcim_modules_update + description: Put a module object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableModuleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableModuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Module' + description: '' + patch: + operationId: dcim_modules_partial_update + description: Patch a module object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableModuleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableModuleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Module' + description: '' + delete: + operationId: dcim_modules_destroy + description: Delete a module object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/platforms/: + get: + operationId: dcim_platforms_list + description: Get a list of platform objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: available_for_device_type + schema: + type: string + - in: query + name: config_template_id + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: config_template_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + description: Immediate parent platform (slug) + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + description: Immediate parent platform (slug) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Immediate parent platform (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Immediate parent platform (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPlatformList' + description: '' + post: + operationId: dcim_platforms_create + description: Post a list of platform objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePlatformRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePlatformRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePlatformRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePlatformRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Platform' + description: '' + put: + operationId: dcim_platforms_bulk_update + description: Put a list of platform objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PlatformRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PlatformRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Platform' + description: '' + patch: + operationId: dcim_platforms_bulk_partial_update + description: Patch a list of platform objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PlatformRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PlatformRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Platform' + description: '' + delete: + operationId: dcim_platforms_bulk_destroy + description: Delete a list of platform objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PlatformRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PlatformRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/platforms/{id}/: + get: + operationId: dcim_platforms_retrieve + description: Get a platform object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this platform. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Platform' + description: '' + put: + operationId: dcim_platforms_update + description: Put a platform object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this platform. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritablePlatformRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritablePlatformRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Platform' + description: '' + patch: + operationId: dcim_platforms_partial_update + description: Patch a platform object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this platform. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritablePlatformRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritablePlatformRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Platform' + description: '' + delete: + operationId: dcim_platforms_destroy + description: Delete a platform object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this platform. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-feeds/: + get: + operationId: dcim_power_feeds_list + description: Get a list of power feed objects. + parameters: + - in: query + name: amperage + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: amperage__empty + schema: + type: boolean + - in: query + name: amperage__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: amperage__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: amperage__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: amperage__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: amperage__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: available_power + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: available_power__empty + schema: + type: boolean + - in: query + name: available_power__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: available_power__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: available_power__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: available_power__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: available_power__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: connected + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: max_utilization + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_utilization__empty + schema: + type: boolean + - in: query + name: max_utilization__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_utilization__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_utilization__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_utilization__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_utilization__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: phase + schema: + type: string + x-spec-enum-id: 994bc0696f4df57f + enum: + - 'null' + - single-phase + - three-phase + description: |- + * `single-phase` - Single phase + * `three-phase` - Three-phase + - in: query + name: phase__empty + schema: + type: boolean + - in: query + name: phase__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__n + schema: + type: string + x-spec-enum-id: 994bc0696f4df57f + enum: + - 'null' + - single-phase + - three-phase + description: |- + * `single-phase` - Single phase + * `three-phase` - Three-phase + - in: query + name: phase__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phase__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: power_panel_id + schema: + type: array + items: + type: integer + description: Power panel (ID) + explode: true + style: form + - in: query + name: power_panel_id__n + schema: + type: array + items: + type: integer + description: Power panel (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: ec530572dc778583 + explode: true + style: form + - in: query + name: supply + schema: + type: string + x-spec-enum-id: 1b6d99616ca6412b + enum: + - ac + - dc + - 'null' + description: |- + * `ac` - AC + * `dc` - DC + - in: query + name: supply__empty + schema: + type: boolean + - in: query + name: supply__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__n + schema: + type: string + x-spec-enum-id: 1b6d99616ca6412b + enum: + - ac + - dc + - 'null' + description: |- + * `ac` - AC + * `dc` - DC + - in: query + name: supply__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: supply__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: string + x-spec-enum-id: 093a164236819eb8 + enum: + - 'null' + - primary + - redundant + description: |- + * `primary` - Primary + * `redundant` - Redundant + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__n + schema: + type: string + x-spec-enum-id: 093a164236819eb8 + enum: + - 'null' + - primary + - redundant + description: |- + * `primary` - Primary + * `redundant` - Redundant + - in: query + name: type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: voltage + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: voltage__empty + schema: + type: boolean + - in: query + name: voltage__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: voltage__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: voltage__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: voltage__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: voltage__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPowerFeedList' + description: '' + post: + operationId: dcim_power_feeds_create + description: Post a list of power feed objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerFeedRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerFeedRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerFeedRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerFeedRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerFeed' + description: '' + put: + operationId: dcim_power_feeds_bulk_update + description: Put a list of power feed objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeedRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeedRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeed' + description: '' + patch: + operationId: dcim_power_feeds_bulk_partial_update + description: Patch a list of power feed objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeedRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeedRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeed' + description: '' + delete: + operationId: dcim_power_feeds_bulk_destroy + description: Delete a list of power feed objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeedRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerFeedRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-feeds/{id}/: + get: + operationId: dcim_power_feeds_retrieve + description: Get a power feed object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power feed. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerFeed' + description: '' + put: + operationId: dcim_power_feeds_update + description: Put a power feed object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power feed. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritablePowerFeedRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritablePowerFeedRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerFeed' + description: '' + patch: + operationId: dcim_power_feeds_partial_update + description: Patch a power feed object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power feed. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritablePowerFeedRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritablePowerFeedRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerFeed' + description: '' + delete: + operationId: dcim_power_feeds_destroy + description: Delete a power feed object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power feed. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-feeds/{id}/trace/: + get: + operationId: dcim_power_feeds_trace_retrieve + description: Trace a complete cable path and return each segment as a three-tuple + of (termination, cable, termination). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power feed. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerFeed' + description: '' + /api/dcim/power-outlet-templates/: + get: + operationId: dcim_power_outlet_templates_list + description: Get a list of power outlet template objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: feed_leg + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__empty + schema: + type: boolean + - in: query + name: feed_leg__ic + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__ie + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__iew + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__isw + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__n + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__nic + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__nie + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__niew + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__regex + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: power_port_id + schema: + type: array + items: + type: integer + nullable: true + description: Power port (ID) + explode: true + style: form + - in: query + name: power_port_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Power port (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + enum: + - California Style + - DC + - IEC 60309 + - IEC 60320 + - IEC 60906-1 + - ITA/International + - Molex + - NEMA (Locking) + - NEMA (Non-locking) + - Other + - Proprietary + - USB + - 'null' + description: |- + * `IEC 60320` - [('iec-60320-c5', 'C5'), ('iec-60320-c7', 'C7'), ('iec-60320-c13', 'C13'), ('iec-60320-c15', 'C15'), ('iec-60320-c17', 'C17'), ('iec-60320-c19', 'C19'), ('iec-60320-c21', 'C21')] + * `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')] + * `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')] + * `NEMA (Non-locking)` - [('nema-1-15r', 'NEMA 1-15R'), ('nema-5-15r', 'NEMA 5-15R'), ('nema-5-20r', 'NEMA 5-20R'), ('nema-5-30r', 'NEMA 5-30R'), ('nema-5-50r', 'NEMA 5-50R'), ('nema-6-15r', 'NEMA 6-15R'), ('nema-6-20r', 'NEMA 6-20R'), ('nema-6-30r', 'NEMA 6-30R'), ('nema-6-50r', 'NEMA 6-50R'), ('nema-10-30r', 'NEMA 10-30R'), ('nema-10-50r', 'NEMA 10-50R'), ('nema-14-20r', 'NEMA 14-20R'), ('nema-14-30r', 'NEMA 14-30R'), ('nema-14-50r', 'NEMA 14-50R'), ('nema-14-60r', 'NEMA 14-60R'), ('nema-15-15r', 'NEMA 15-15R'), ('nema-15-20r', 'NEMA 15-20R'), ('nema-15-30r', 'NEMA 15-30R'), ('nema-15-50r', 'NEMA 15-50R'), ('nema-15-60r', 'NEMA 15-60R')] + * `NEMA (Locking)` - [('nema-l1-15r', 'NEMA L1-15R'), ('nema-l5-15r', 'NEMA L5-15R'), ('nema-l5-20r', 'NEMA L5-20R'), ('nema-l5-30r', 'NEMA L5-30R'), ('nema-l5-50r', 'NEMA L5-50R'), ('nema-l6-15r', 'NEMA L6-15R'), ('nema-l6-20r', 'NEMA L6-20R'), ('nema-l6-30r', 'NEMA L6-30R'), ('nema-l6-50r', 'NEMA L6-50R'), ('nema-l10-30r', 'NEMA L10-30R'), ('nema-l14-20r', 'NEMA L14-20R'), ('nema-l14-30r', 'NEMA L14-30R'), ('nema-l14-50r', 'NEMA L14-50R'), ('nema-l14-60r', 'NEMA L14-60R'), ('nema-l15-20r', 'NEMA L15-20R'), ('nema-l15-30r', 'NEMA L15-30R'), ('nema-l15-50r', 'NEMA L15-50R'), ('nema-l15-60r', 'NEMA L15-60R'), ('nema-l21-20r', 'NEMA L21-20R'), ('nema-l21-30r', 'NEMA L21-30R'), ('nema-l22-20r', 'NEMA L22-20R'), ('nema-l22-30r', 'NEMA L22-30R')] + * `California Style` - [('CS6360C', 'CS6360C'), ('CS6364C', 'CS6364C'), ('CS8164C', 'CS8164C'), ('CS8264C', 'CS8264C'), ('CS8364C', 'CS8364C'), ('CS8464C', 'CS8464C')] + * `ITA/International` - [('ita-e', 'ITA Type E (CEE 7/5)'), ('ita-f', 'ITA Type F (CEE 7/3)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O'), ('ita-multistandard', 'ITA Multistandard')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-micro-b', 'USB Micro B'), ('usb-c', 'USB Type C')] + * `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] + * `DC` - [('dc-terminal', 'DC Terminal')] + * `Proprietary` - [('eaton-c39', 'Eaton C39'), ('hdot-cx', 'HDOT Cx'), ('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20a', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32a', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')] + * `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')] + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__n + schema: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + enum: + - California Style + - DC + - IEC 60309 + - IEC 60320 + - IEC 60906-1 + - ITA/International + - Molex + - NEMA (Locking) + - NEMA (Non-locking) + - Other + - Proprietary + - USB + - 'null' + description: |- + * `IEC 60320` - [('iec-60320-c5', 'C5'), ('iec-60320-c7', 'C7'), ('iec-60320-c13', 'C13'), ('iec-60320-c15', 'C15'), ('iec-60320-c17', 'C17'), ('iec-60320-c19', 'C19'), ('iec-60320-c21', 'C21')] + * `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')] + * `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')] + * `NEMA (Non-locking)` - [('nema-1-15r', 'NEMA 1-15R'), ('nema-5-15r', 'NEMA 5-15R'), ('nema-5-20r', 'NEMA 5-20R'), ('nema-5-30r', 'NEMA 5-30R'), ('nema-5-50r', 'NEMA 5-50R'), ('nema-6-15r', 'NEMA 6-15R'), ('nema-6-20r', 'NEMA 6-20R'), ('nema-6-30r', 'NEMA 6-30R'), ('nema-6-50r', 'NEMA 6-50R'), ('nema-10-30r', 'NEMA 10-30R'), ('nema-10-50r', 'NEMA 10-50R'), ('nema-14-20r', 'NEMA 14-20R'), ('nema-14-30r', 'NEMA 14-30R'), ('nema-14-50r', 'NEMA 14-50R'), ('nema-14-60r', 'NEMA 14-60R'), ('nema-15-15r', 'NEMA 15-15R'), ('nema-15-20r', 'NEMA 15-20R'), ('nema-15-30r', 'NEMA 15-30R'), ('nema-15-50r', 'NEMA 15-50R'), ('nema-15-60r', 'NEMA 15-60R')] + * `NEMA (Locking)` - [('nema-l1-15r', 'NEMA L1-15R'), ('nema-l5-15r', 'NEMA L5-15R'), ('nema-l5-20r', 'NEMA L5-20R'), ('nema-l5-30r', 'NEMA L5-30R'), ('nema-l5-50r', 'NEMA L5-50R'), ('nema-l6-15r', 'NEMA L6-15R'), ('nema-l6-20r', 'NEMA L6-20R'), ('nema-l6-30r', 'NEMA L6-30R'), ('nema-l6-50r', 'NEMA L6-50R'), ('nema-l10-30r', 'NEMA L10-30R'), ('nema-l14-20r', 'NEMA L14-20R'), ('nema-l14-30r', 'NEMA L14-30R'), ('nema-l14-50r', 'NEMA L14-50R'), ('nema-l14-60r', 'NEMA L14-60R'), ('nema-l15-20r', 'NEMA L15-20R'), ('nema-l15-30r', 'NEMA L15-30R'), ('nema-l15-50r', 'NEMA L15-50R'), ('nema-l15-60r', 'NEMA L15-60R'), ('nema-l21-20r', 'NEMA L21-20R'), ('nema-l21-30r', 'NEMA L21-30R'), ('nema-l22-20r', 'NEMA L22-20R'), ('nema-l22-30r', 'NEMA L22-30R')] + * `California Style` - [('CS6360C', 'CS6360C'), ('CS6364C', 'CS6364C'), ('CS8164C', 'CS8164C'), ('CS8264C', 'CS8264C'), ('CS8364C', 'CS8364C'), ('CS8464C', 'CS8464C')] + * `ITA/International` - [('ita-e', 'ITA Type E (CEE 7/5)'), ('ita-f', 'ITA Type F (CEE 7/3)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O'), ('ita-multistandard', 'ITA Multistandard')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-micro-b', 'USB Micro B'), ('usb-c', 'USB Type C')] + * `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] + * `DC` - [('dc-terminal', 'DC Terminal')] + * `Proprietary` - [('eaton-c39', 'Eaton C39'), ('hdot-cx', 'HDOT Cx'), ('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20a', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32a', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')] + * `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')] + - in: query + name: type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPowerOutletTemplateList' + description: '' + post: + operationId: dcim_power_outlet_templates_create + description: Post a list of power outlet template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutletTemplate' + description: '' + put: + operationId: dcim_power_outlet_templates_bulk_update + description: Put a list of power outlet template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplate' + description: '' + patch: + operationId: dcim_power_outlet_templates_bulk_partial_update + description: Patch a list of power outlet template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplate' + description: '' + delete: + operationId: dcim_power_outlet_templates_bulk_destroy + description: Delete a list of power outlet template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-outlet-templates/{id}/: + get: + operationId: dcim_power_outlet_templates_retrieve + description: Get a power outlet template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutletTemplate' + description: '' + put: + operationId: dcim_power_outlet_templates_update + description: Put a power outlet template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutletTemplate' + description: '' + patch: + operationId: dcim_power_outlet_templates_partial_update + description: Patch a power outlet template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritablePowerOutletTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritablePowerOutletTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutletTemplate' + description: '' + delete: + operationId: dcim_power_outlet_templates_destroy + description: Delete a power outlet template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-outlets/: + get: + operationId: dcim_power_outlets_list + description: Get a list of power outlet objects. + parameters: + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: connected + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: feed_leg + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__empty + schema: + type: boolean + - in: query + name: feed_leg__ic + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__ie + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__iew + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__isw + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__n + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__nic + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__nie + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__niew + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: feed_leg__regex + schema: + type: array + items: + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: Phase (for three-phase feeds) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: power_port_id + schema: + type: array + items: + type: integer + nullable: true + description: Power port (ID) + explode: true + style: form + - in: query + name: power_port_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Power port (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: d60dce16858f3c69 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPowerOutletList' + description: '' + post: + operationId: dcim_power_outlets_create + description: Post a list of power outlet objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerOutletRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerOutletRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerOutletRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerOutletRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutlet' + description: '' + put: + operationId: dcim_power_outlets_bulk_update + description: Put a list of power outlet objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutlet' + description: '' + patch: + operationId: dcim_power_outlets_bulk_partial_update + description: Patch a list of power outlet objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutlet' + description: '' + delete: + operationId: dcim_power_outlets_bulk_destroy + description: Delete a list of power outlet objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerOutletRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-outlets/{id}/: + get: + operationId: dcim_power_outlets_retrieve + description: Get a power outlet object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutlet' + description: '' + put: + operationId: dcim_power_outlets_update + description: Put a power outlet object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritablePowerOutletRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritablePowerOutletRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutlet' + description: '' + patch: + operationId: dcim_power_outlets_partial_update + description: Patch a power outlet object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritablePowerOutletRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritablePowerOutletRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutlet' + description: '' + delete: + operationId: dcim_power_outlets_destroy + description: Delete a power outlet object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-outlets/{id}/trace/: + get: + operationId: dcim_power_outlets_trace_retrieve + description: Trace a complete cable path and return each segment as a three-tuple + of (termination, cable, termination). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power outlet. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerOutlet' + description: '' + /api/dcim/power-panels/: + get: + operationId: dcim_power_panels_list + description: Get a list of power panel objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPowerPanelList' + description: '' + post: + operationId: dcim_power_panels_create + description: Post a list of power panel objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PowerPanelRequest' + - type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/PowerPanelRequest' + - type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPanel' + description: '' + put: + operationId: dcim_power_panels_bulk_update + description: Put a list of power panel objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanel' + description: '' + patch: + operationId: dcim_power_panels_bulk_partial_update + description: Patch a list of power panel objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanel' + description: '' + delete: + operationId: dcim_power_panels_bulk_destroy + description: Delete a list of power panel objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPanelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-panels/{id}/: + get: + operationId: dcim_power_panels_retrieve + description: Get a power panel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power panel. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPanel' + description: '' + put: + operationId: dcim_power_panels_update + description: Put a power panel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power panel. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPanelRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PowerPanelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPanel' + description: '' + patch: + operationId: dcim_power_panels_partial_update + description: Patch a power panel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power panel. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedPowerPanelRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedPowerPanelRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPanel' + description: '' + delete: + operationId: dcim_power_panels_destroy + description: Delete a power panel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power panel. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-port-templates/: + get: + operationId: dcim_power_port_templates_list + description: Get a list of power port template objects. + parameters: + - in: query + name: allocated_draw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__empty + schema: + type: boolean + - in: query + name: allocated_draw__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: maximum_draw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__empty + schema: + type: boolean + - in: query + name: maximum_draw__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + enum: + - California Style + - DC + - IEC 60309 + - IEC 60320 + - IEC 60906-1 + - International/ITA + - Molex + - NEMA (Locking) + - NEMA (Non-locking) + - Other + - Proprietary + - USB + - 'null' + description: |- + * `IEC 60320` - [('iec-60320-c6', 'C6'), ('iec-60320-c8', 'C8'), ('iec-60320-c14', 'C14'), ('iec-60320-c16', 'C16'), ('iec-60320-c18', 'C18'), ('iec-60320-c20', 'C20'), ('iec-60320-c22', 'C22')] + * `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')] + * `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')] + * `NEMA (Non-locking)` - [('nema-1-15p', 'NEMA 1-15P'), ('nema-5-15p', 'NEMA 5-15P'), ('nema-5-20p', 'NEMA 5-20P'), ('nema-5-30p', 'NEMA 5-30P'), ('nema-5-50p', 'NEMA 5-50P'), ('nema-6-15p', 'NEMA 6-15P'), ('nema-6-20p', 'NEMA 6-20P'), ('nema-6-30p', 'NEMA 6-30P'), ('nema-6-50p', 'NEMA 6-50P'), ('nema-10-30p', 'NEMA 10-30P'), ('nema-10-50p', 'NEMA 10-50P'), ('nema-14-20p', 'NEMA 14-20P'), ('nema-14-30p', 'NEMA 14-30P'), ('nema-14-50p', 'NEMA 14-50P'), ('nema-14-60p', 'NEMA 14-60P'), ('nema-15-15p', 'NEMA 15-15P'), ('nema-15-20p', 'NEMA 15-20P'), ('nema-15-30p', 'NEMA 15-30P'), ('nema-15-50p', 'NEMA 15-50P'), ('nema-15-60p', 'NEMA 15-60P')] + * `NEMA (Locking)` - [('nema-l1-15p', 'NEMA L1-15P'), ('nema-l5-15p', 'NEMA L5-15P'), ('nema-l5-20p', 'NEMA L5-20P'), ('nema-l5-30p', 'NEMA L5-30P'), ('nema-l5-50p', 'NEMA L5-50P'), ('nema-l6-15p', 'NEMA L6-15P'), ('nema-l6-20p', 'NEMA L6-20P'), ('nema-l6-30p', 'NEMA L6-30P'), ('nema-l6-50p', 'NEMA L6-50P'), ('nema-l10-30p', 'NEMA L10-30P'), ('nema-l14-20p', 'NEMA L14-20P'), ('nema-l14-30p', 'NEMA L14-30P'), ('nema-l14-50p', 'NEMA L14-50P'), ('nema-l14-60p', 'NEMA L14-60P'), ('nema-l15-20p', 'NEMA L15-20P'), ('nema-l15-30p', 'NEMA L15-30P'), ('nema-l15-50p', 'NEMA L15-50P'), ('nema-l15-60p', 'NEMA L15-60P'), ('nema-l21-20p', 'NEMA L21-20P'), ('nema-l21-30p', 'NEMA L21-30P'), ('nema-l22-20p', 'NEMA L22-20P'), ('nema-l22-30p', 'NEMA L22-30P')] + * `California Style` - [('cs6361c', 'CS6361C'), ('cs6365c', 'CS6365C'), ('cs8165c', 'CS8165C'), ('cs8265c', 'CS8265C'), ('cs8365c', 'CS8365C'), ('cs8465c', 'CS8465C')] + * `International/ITA` - [('ita-c', 'ITA Type C (CEE 7/16)'), ('ita-e', 'ITA Type E (CEE 7/6)'), ('ita-f', 'ITA Type F (CEE 7/4)'), ('ita-ef', 'ITA Type E/F (CEE 7/7)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB'), ('usb-3-b', 'USB 3.0 Type B'), ('usb-3-micro-b', 'USB 3.0 Micro B')] + * `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] + * `DC` - [('dc-terminal', 'DC Terminal')] + * `Proprietary` - [('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')] + * `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')] + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__n + schema: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + enum: + - California Style + - DC + - IEC 60309 + - IEC 60320 + - IEC 60906-1 + - International/ITA + - Molex + - NEMA (Locking) + - NEMA (Non-locking) + - Other + - Proprietary + - USB + - 'null' + description: |- + * `IEC 60320` - [('iec-60320-c6', 'C6'), ('iec-60320-c8', 'C8'), ('iec-60320-c14', 'C14'), ('iec-60320-c16', 'C16'), ('iec-60320-c18', 'C18'), ('iec-60320-c20', 'C20'), ('iec-60320-c22', 'C22')] + * `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')] + * `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')] + * `NEMA (Non-locking)` - [('nema-1-15p', 'NEMA 1-15P'), ('nema-5-15p', 'NEMA 5-15P'), ('nema-5-20p', 'NEMA 5-20P'), ('nema-5-30p', 'NEMA 5-30P'), ('nema-5-50p', 'NEMA 5-50P'), ('nema-6-15p', 'NEMA 6-15P'), ('nema-6-20p', 'NEMA 6-20P'), ('nema-6-30p', 'NEMA 6-30P'), ('nema-6-50p', 'NEMA 6-50P'), ('nema-10-30p', 'NEMA 10-30P'), ('nema-10-50p', 'NEMA 10-50P'), ('nema-14-20p', 'NEMA 14-20P'), ('nema-14-30p', 'NEMA 14-30P'), ('nema-14-50p', 'NEMA 14-50P'), ('nema-14-60p', 'NEMA 14-60P'), ('nema-15-15p', 'NEMA 15-15P'), ('nema-15-20p', 'NEMA 15-20P'), ('nema-15-30p', 'NEMA 15-30P'), ('nema-15-50p', 'NEMA 15-50P'), ('nema-15-60p', 'NEMA 15-60P')] + * `NEMA (Locking)` - [('nema-l1-15p', 'NEMA L1-15P'), ('nema-l5-15p', 'NEMA L5-15P'), ('nema-l5-20p', 'NEMA L5-20P'), ('nema-l5-30p', 'NEMA L5-30P'), ('nema-l5-50p', 'NEMA L5-50P'), ('nema-l6-15p', 'NEMA L6-15P'), ('nema-l6-20p', 'NEMA L6-20P'), ('nema-l6-30p', 'NEMA L6-30P'), ('nema-l6-50p', 'NEMA L6-50P'), ('nema-l10-30p', 'NEMA L10-30P'), ('nema-l14-20p', 'NEMA L14-20P'), ('nema-l14-30p', 'NEMA L14-30P'), ('nema-l14-50p', 'NEMA L14-50P'), ('nema-l14-60p', 'NEMA L14-60P'), ('nema-l15-20p', 'NEMA L15-20P'), ('nema-l15-30p', 'NEMA L15-30P'), ('nema-l15-50p', 'NEMA L15-50P'), ('nema-l15-60p', 'NEMA L15-60P'), ('nema-l21-20p', 'NEMA L21-20P'), ('nema-l21-30p', 'NEMA L21-30P'), ('nema-l22-20p', 'NEMA L22-20P'), ('nema-l22-30p', 'NEMA L22-30P')] + * `California Style` - [('cs6361c', 'CS6361C'), ('cs6365c', 'CS6365C'), ('cs8165c', 'CS8165C'), ('cs8265c', 'CS8265C'), ('cs8365c', 'CS8365C'), ('cs8465c', 'CS8465C')] + * `International/ITA` - [('ita-c', 'ITA Type C (CEE 7/16)'), ('ita-e', 'ITA Type E (CEE 7/6)'), ('ita-f', 'ITA Type F (CEE 7/4)'), ('ita-ef', 'ITA Type E/F (CEE 7/7)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O')] + * `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB'), ('usb-3-b', 'USB 3.0 Type B'), ('usb-3-micro-b', 'USB 3.0 Micro B')] + * `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')] + * `DC` - [('dc-terminal', 'DC Terminal')] + * `Proprietary` - [('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')] + * `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')] + - in: query + name: type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPowerPortTemplateList' + description: '' + post: + operationId: dcim_power_port_templates_create + description: Post a list of power port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerPortTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPortTemplate' + description: '' + put: + operationId: dcim_power_port_templates_bulk_update + description: Put a list of power port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplate' + description: '' + patch: + operationId: dcim_power_port_templates_bulk_partial_update + description: Patch a list of power port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplate' + description: '' + delete: + operationId: dcim_power_port_templates_bulk_destroy + description: Delete a list of power port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-port-templates/{id}/: + get: + operationId: dcim_power_port_templates_retrieve + description: Get a power port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPortTemplate' + description: '' + put: + operationId: dcim_power_port_templates_update + description: Put a power port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritablePowerPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritablePowerPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPortTemplate' + description: '' + patch: + operationId: dcim_power_port_templates_partial_update + description: Patch a power port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritablePowerPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritablePowerPortTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPortTemplate' + description: '' + delete: + operationId: dcim_power_port_templates_destroy + description: Delete a power port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-ports/: + get: + operationId: dcim_power_ports_list + description: Get a list of power port objects. + parameters: + - in: query + name: allocated_draw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__empty + schema: + type: boolean + - in: query + name: allocated_draw__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: allocated_draw__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: connected + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: maximum_draw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__empty + schema: + type: boolean + - in: query + name: maximum_draw__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: maximum_draw__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: Physical port type + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPowerPortList' + description: '' + post: + operationId: dcim_power_ports_create + description: Post a list of power port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerPortRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePowerPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePowerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPort' + description: '' + put: + operationId: dcim_power_ports_bulk_update + description: Put a list of power port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPort' + description: '' + patch: + operationId: dcim_power_ports_bulk_partial_update + description: Patch a list of power port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPort' + description: '' + delete: + operationId: dcim_power_ports_bulk_destroy + description: Delete a list of power port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PowerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-ports/{id}/: + get: + operationId: dcim_power_ports_retrieve + description: Get a power port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPort' + description: '' + put: + operationId: dcim_power_ports_update + description: Put a power port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritablePowerPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritablePowerPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPort' + description: '' + patch: + operationId: dcim_power_ports_partial_update + description: Patch a power port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritablePowerPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritablePowerPortRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPort' + description: '' + delete: + operationId: dcim_power_ports_destroy + description: Delete a power port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/power-ports/{id}/trace/: + get: + operationId: dcim_power_ports_trace_retrieve + description: Trace a complete cable path and return each segment as a three-tuple + of (termination, cable, termination). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this power port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PowerPort' + description: '' + /api/dcim/rack-groups/: + get: + operationId: dcim_rack_groups_list + description: Get a list of rack group objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRackGroupList' + description: '' + post: + operationId: dcim_rack_groups_create + description: Post a list of rack group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/RackGroupRequest' + - type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/RackGroupRequest' + - type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RackGroup' + description: '' + put: + operationId: dcim_rack_groups_bulk_update + description: Put a list of rack group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroup' + description: '' + patch: + operationId: dcim_rack_groups_bulk_partial_update + description: Patch a list of rack group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroup' + description: '' + delete: + operationId: dcim_rack_groups_bulk_destroy + description: Delete a list of rack group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rack-groups/{id}/: + get: + operationId: dcim_rack_groups_retrieve + description: Get a rack group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack group. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackGroup' + description: '' + put: + operationId: dcim_rack_groups_update + description: Put a rack group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack group. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RackGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/RackGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackGroup' + description: '' + patch: + operationId: dcim_rack_groups_partial_update + description: Patch a rack group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack group. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedRackGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedRackGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackGroup' + description: '' + delete: + operationId: dcim_rack_groups_destroy + description: Delete a rack group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack group. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rack-reservations/: + get: + operationId: dcim_rack_reservations_list + description: Get a list of rack reservation objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + description: Group (slug) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Group (slug) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + description: Group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + description: Group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: ed6038a4deee151c + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: unit + schema: + type: number + - in: query + name: unit__empty + schema: + type: number + - in: query + name: unit__gt + schema: + type: number + - in: query + name: unit__gte + schema: + type: number + - in: query + name: unit__lt + schema: + type: number + - in: query + name: unit__lte + schema: + type: number + - in: query + name: unit__n + schema: + type: number + - in: query + name: unit_count_max + schema: + type: number + description: Maximum unit count + - in: query + name: unit_count_min + schema: + type: number + description: Minimum unit count + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: user + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRackReservationList' + description: '' + post: + operationId: dcim_rack_reservations_create + description: Post a list of rack reservation objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRackReservationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRackReservationRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRackReservationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRackReservationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RackReservation' + description: '' + put: + operationId: dcim_rack_reservations_bulk_update + description: Put a list of rack reservation objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservation' + description: '' + patch: + operationId: dcim_rack_reservations_bulk_partial_update + description: Patch a list of rack reservation objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservation' + description: '' + delete: + operationId: dcim_rack_reservations_bulk_destroy + description: Delete a list of rack reservation objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackReservationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rack-reservations/{id}/: + get: + operationId: dcim_rack_reservations_retrieve + description: Get a rack reservation object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack reservation. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackReservation' + description: '' + put: + operationId: dcim_rack_reservations_update + description: Put a rack reservation object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack reservation. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableRackReservationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableRackReservationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackReservation' + description: '' + patch: + operationId: dcim_rack_reservations_partial_update + description: Patch a rack reservation object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack reservation. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableRackReservationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableRackReservationRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackReservation' + description: '' + delete: + operationId: dcim_rack_reservations_destroy + description: Delete a rack reservation object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack reservation. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rack-roles/: + get: + operationId: dcim_rack_roles_list + description: Get a list of rack role objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRackRoleList' + description: '' + post: + operationId: dcim_rack_roles_create + description: Post a list of rack role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/RackRoleRequest' + - type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/RackRoleRequest' + - type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RackRole' + description: '' + put: + operationId: dcim_rack_roles_bulk_update + description: Put a list of rack role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRole' + description: '' + patch: + operationId: dcim_rack_roles_bulk_partial_update + description: Patch a list of rack role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRole' + description: '' + delete: + operationId: dcim_rack_roles_bulk_destroy + description: Delete a list of rack role objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rack-roles/{id}/: + get: + operationId: dcim_rack_roles_retrieve + description: Get a rack role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack role. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackRole' + description: '' + put: + operationId: dcim_rack_roles_update + description: Put a rack role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack role. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RackRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/RackRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackRole' + description: '' + patch: + operationId: dcim_rack_roles_partial_update + description: Patch a rack role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack role. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedRackRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedRackRoleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackRole' + description: '' + delete: + operationId: dcim_rack_roles_destroy + description: Delete a rack role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack role. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rack-types/: + get: + operationId: dcim_rack_types_list + description: Get a list of rack type objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: desc_units + schema: + type: boolean + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: form_factor + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__empty + schema: + type: boolean + - in: query + name: form_factor__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__n + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: form_factor__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: max_weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__empty + schema: + type: boolean + - in: query + name: max_weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: model + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__empty + schema: + type: boolean + - in: query + name: model__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: model__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: mounting_depth + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__empty + schema: + type: boolean + - in: query + name: mounting_depth__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: outer_depth + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__empty + schema: + type: boolean + - in: query + name: outer_depth__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__empty + schema: + type: boolean + - in: query + name: outer_height__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_unit + schema: + type: string + x-spec-enum-id: 3d701848b66312c3 + nullable: true + enum: + - in + - mm + - 'null' + description: |- + * `mm` - Millimeters + * `in` - Inches + - in: query + name: outer_unit__empty + schema: + type: boolean + - in: query + name: outer_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__n + schema: + type: string + x-spec-enum-id: 3d701848b66312c3 + nullable: true + enum: + - in + - mm + - 'null' + description: |- + * `mm` - Millimeters + * `in` - Inches + - in: query + name: outer_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_width + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__empty + schema: + type: boolean + - in: query + name: outer_width__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rack_count__empty + schema: + type: boolean + - in: query + name: rack_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rack_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rack_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rack_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: rack_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: starting_unit + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__empty + schema: + type: boolean + - in: query + name: starting_unit__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: u_height + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__empty + schema: + type: boolean + - in: query + name: u_height__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight_unit + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__empty + schema: + type: boolean + - in: query + name: weight_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__n + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: width + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__ic + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__ie + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__iew + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__iregex + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__isw + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__n + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__nic + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__nie + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__niew + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__nisw + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__regex + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRackTypeList' + description: '' + post: + operationId: dcim_rack_types_create + description: Post a list of rack type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRackTypeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRackTypeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRackTypeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRackTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RackType' + description: '' + put: + operationId: dcim_rack_types_bulk_update + description: Put a list of rack type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackType' + description: '' + patch: + operationId: dcim_rack_types_bulk_partial_update + description: Patch a list of rack type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackType' + description: '' + delete: + operationId: dcim_rack_types_bulk_destroy + description: Delete a list of rack type objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rack-types/{id}/: + get: + operationId: dcim_rack_types_retrieve + description: Get a rack type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack type. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackType' + description: '' + put: + operationId: dcim_rack_types_update + description: Put a rack type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack type. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableRackTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableRackTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackType' + description: '' + patch: + operationId: dcim_rack_types_partial_update + description: Patch a rack type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack type. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableRackTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableRackTypeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RackType' + description: '' + delete: + operationId: dcim_rack_types_destroy + description: Delete a rack type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack type. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/racks/: + get: + operationId: dcim_racks_list + description: Get a list of rack objects. + parameters: + - in: query + name: airflow + schema: + type: string + x-spec-enum-id: a784734d07ef1b3c + nullable: true + enum: + - front-to-rear + - 'null' + - rear-to-front + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + - in: query + name: airflow__empty + schema: + type: boolean + - in: query + name: airflow__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__n + schema: + type: string + x-spec-enum-id: a784734d07ef1b3c + nullable: true + enum: + - front-to-rear + - 'null' + - rear-to-front + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + - in: query + name: airflow__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: airflow__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__empty + schema: + type: boolean + - in: query + name: asset_tag__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: asset_tag__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: desc_units + schema: + type: boolean + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__empty + schema: + type: boolean + - in: query + name: facility_id__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility_id__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: form_factor + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__empty + schema: + type: boolean + - in: query + name: form_factor__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__n + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: form_factor__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 8a902fde21d48841 + nullable: true + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + description: Group (slug) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Group (slug) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + nullable: true + description: Group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: manufacturer + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer__n + schema: + type: array + items: + type: string + description: Manufacturer (slug) + explode: true + style: form + - in: query + name: manufacturer_id + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: manufacturer_id__n + schema: + type: array + items: + type: integer + description: Manufacturer (ID) + explode: true + style: form + - in: query + name: max_weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__empty + schema: + type: boolean + - in: query + name: max_weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: max_weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: mounting_depth + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__empty + schema: + type: boolean + - in: query + name: mounting_depth__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mounting_depth__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: outer_depth + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__empty + schema: + type: boolean + - in: query + name: outer_depth__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_depth__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__empty + schema: + type: boolean + - in: query + name: outer_height__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_height__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_unit + schema: + type: string + x-spec-enum-id: 3d701848b66312c3 + nullable: true + enum: + - in + - mm + - 'null' + description: |- + * `mm` - Millimeters + * `in` - Inches + - in: query + name: outer_unit__empty + schema: + type: boolean + - in: query + name: outer_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__n + schema: + type: string + x-spec-enum-id: 3d701848b66312c3 + nullable: true + enum: + - in + - mm + - 'null' + description: |- + * `mm` - Millimeters + * `in` - Inches + - in: query + name: outer_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: outer_width + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__empty + schema: + type: boolean + - in: query + name: outer_width__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: outer_width__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack_type + schema: + type: array + items: + type: string + description: Rack type (slug) + explode: true + style: form + - in: query + name: rack_type__n + schema: + type: array + items: + type: string + description: Rack type (slug) + explode: true + style: form + - in: query + name: rack_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Rack type (ID) + explode: true + style: form + - in: query + name: rack_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Rack type (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: serial + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__empty + schema: + type: boolean + - in: query + name: serial__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: starting_unit + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__empty + schema: + type: boolean + - in: query + name: starting_unit__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: starting_unit__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 76eea4eef8804bcb + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: u_height + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__empty + schema: + type: boolean + - in: query + name: u_height__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: u_height__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: weight_unit + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__empty + schema: + type: boolean + - in: query + name: weight_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__n + schema: + type: string + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + enum: + - g + - kg + - lb + - 'null' + - oz + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + - in: query + name: weight_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: width + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__ic + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__ie + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__iew + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__iregex + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__isw + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__n + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__nic + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__nie + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__niew + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__nisw + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + - in: query + name: width__regex + schema: + type: array + items: + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: Rail-to-rail width + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRackList' + description: '' + post: + operationId: dcim_racks_create + description: Post a list of rack objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRackRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRackRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRackRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRackRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Rack' + description: '' + put: + operationId: dcim_racks_bulk_update + description: Put a list of rack objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Rack' + description: '' + patch: + operationId: dcim_racks_bulk_partial_update + description: Patch a list of rack objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Rack' + description: '' + delete: + operationId: dcim_racks_bulk_destroy + description: Delete a list of rack objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RackRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RackRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/racks/{id}/: + get: + operationId: dcim_racks_retrieve + description: Get a rack object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Rack' + description: '' + put: + operationId: dcim_racks_update + description: Put a rack object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableRackRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableRackRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Rack' + description: '' + patch: + operationId: dcim_racks_partial_update + description: Patch a rack object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableRackRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableRackRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Rack' + description: '' + delete: + operationId: dcim_racks_destroy + description: Delete a rack object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/racks/{id}/elevation/: + get: + operationId: dcim_racks_elevation_retrieve + description: Rack elevation representing the list of rack units. Also supports + rendering the elevation as an SVG. + parameters: + - in: query + name: exclude + schema: + type: integer + - in: query + name: expand_devices + schema: + type: boolean + default: true + - in: query + name: face + schema: + enum: + - front + - rear + type: string + x-spec-enum-id: d2fb9b3f75158b83 + default: front + minLength: 1 + description: |- + * `front` - Front + * `rear` - Rear + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rack. + required: true + - in: query + name: include_images + schema: + type: boolean + default: true + - in: query + name: legend_width + schema: + type: integer + default: 30 + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: margin_width + schema: + type: integer + default: 15 + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - in: query + name: q + schema: + type: string + minLength: 1 + - in: query + name: render + schema: + enum: + - json + - svg + type: string + x-spec-enum-id: 09901a5ff13ba07a + default: json + minLength: 1 + description: |- + * `json` - json + * `svg` - svg + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: unit_height + schema: + type: integer + - in: query + name: unit_width + schema: + type: integer + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRackUnitList' + description: '' + /api/dcim/rear-port-templates/: + get: + operationId: dcim_rear_port_templates_list + description: Get a list of rear port template objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device type (ID) + explode: true + style: form + - in: query + name: front_port_id + schema: + type: array + items: + type: integer + description: Front port (ID) + explode: true + style: form + - in: query + name: front_port_id__n + schema: + type: array + items: + type: integer + description: Front port (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_type_id + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: module_type_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module type (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: positions + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__empty + schema: + type: boolean + - in: query + name: positions__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRearPortTemplateList' + description: '' + post: + operationId: dcim_rear_port_templates_create + description: Post a list of rear port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRearPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRearPortTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRearPortTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRearPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPortTemplate' + description: '' + put: + operationId: dcim_rear_port_templates_bulk_update + description: Put a list of rear port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplate' + description: '' + patch: + operationId: dcim_rear_port_templates_bulk_partial_update + description: Patch a list of rear port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplate' + description: '' + delete: + operationId: dcim_rear_port_templates_bulk_destroy + description: Delete a list of rear port template objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rear-port-templates/{id}/: + get: + operationId: dcim_rear_port_templates_retrieve + description: Get a rear port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPortTemplate' + description: '' + put: + operationId: dcim_rear_port_templates_update + description: Put a rear port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableRearPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableRearPortTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPortTemplate' + description: '' + patch: + operationId: dcim_rear_port_templates_partial_update + description: Patch a rear port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port template. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableRearPortTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableRearPortTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPortTemplate' + description: '' + delete: + operationId: dcim_rear_port_templates_destroy + description: Delete a rear port template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port template. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rear-ports/: + get: + operationId: dcim_rear_ports_list + description: Get a list of rear port objects. + parameters: + - in: query + name: cable_connector + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__empty + schema: + type: boolean + - in: query + name: cable_connector__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_connector__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: cable_end + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__empty + schema: + type: boolean + - in: query + name: cable_end__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__n + schema: + type: string + x-spec-enum-id: 1db84f9b93b261c8 + nullable: true + enum: + - A + - B + - 'null' + description: |- + * `A` - A + * `B` - B + - in: query + name: cable_end__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_end__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: cable_id + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cable_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cable (ID) + explode: true + style: form + - in: query + name: cabled + schema: + type: boolean + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Device role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Device role (ID) + explode: true + style: form + - in: query + name: device_status + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__empty + schema: + type: boolean + - in: query + name: device_status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65feb4244cc9110c + explode: true + style: form + - in: query + name: device_type + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type__n + schema: + type: array + items: + type: string + description: Device type (model) + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type (ID) + explode: true + style: form + - in: query + name: front_port_id + schema: + type: array + items: + type: integer + description: Front port (ID) + explode: true + style: form + - in: query + name: front_port_id__n + schema: + type: array + items: + type: integer + description: Front port (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location (ID) + explode: true + style: form + - in: query + name: mark_connected + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: module_id + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: occupied + schema: + type: boolean + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: positions + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__empty + schema: + type: boolean + - in: query + name: positions__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: positions__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack__n + schema: + type: array + items: + type: string + description: Rack (name) + explode: true + style: form + - in: query + name: rack_id + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: rack_id__n + schema: + type: array + items: + type: integer + description: Rack (ID) + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 2696b7065f33307c + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_chassis + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis__n + schema: + type: array + items: + type: string + description: Virtual Chassis + explode: true + style: form + - in: query + name: virtual_chassis_id + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + - in: query + name: virtual_chassis_id__n + schema: + type: array + items: + type: integer + description: Virtual Chassis (ID) + explode: true + style: form + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRearPortList' + description: '' + post: + operationId: dcim_rear_ports_create + description: Post a list of rear port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRearPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRearPortRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRearPortRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRearPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPort' + description: '' + put: + operationId: dcim_rear_ports_bulk_update + description: Put a list of rear port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPort' + description: '' + patch: + operationId: dcim_rear_ports_bulk_partial_update + description: Patch a list of rear port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPort' + description: '' + delete: + operationId: dcim_rear_ports_bulk_destroy + description: Delete a list of rear port objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RearPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rear-ports/{id}/: + get: + operationId: dcim_rear_ports_retrieve + description: Get a rear port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPort' + description: '' + put: + operationId: dcim_rear_ports_update + description: Put a rear port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableRearPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableRearPortRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPort' + description: '' + patch: + operationId: dcim_rear_ports_partial_update + description: Patch a rear port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableRearPortRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableRearPortRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPort' + description: '' + delete: + operationId: dcim_rear_ports_destroy + description: Delete a rear port object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/rear-ports/{id}/paths/: + get: + operationId: dcim_rear_ports_paths_retrieve + description: Return all CablePaths which traverse a given pass-through port. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this rear port. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RearPort' + description: '' + /api/dcim/regions/: + get: + operationId: dcim_regions_list + description: Get a list of region objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + description: Parent region (slug) + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + description: Parent region (slug) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent region (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent region (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRegionList' + description: '' + post: + operationId: dcim_regions_create + description: Post a list of region objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRegionRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRegionRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableRegionRequest' + - type: array + items: + $ref: '#/components/schemas/WritableRegionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Region' + description: '' + put: + operationId: dcim_regions_bulk_update + description: Put a list of region objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RegionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RegionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Region' + description: '' + patch: + operationId: dcim_regions_bulk_partial_update + description: Patch a list of region objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RegionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RegionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Region' + description: '' + delete: + operationId: dcim_regions_bulk_destroy + description: Delete a list of region objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RegionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RegionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/regions/{id}/: + get: + operationId: dcim_regions_retrieve + description: Get a region object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this region. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Region' + description: '' + put: + operationId: dcim_regions_update + description: Put a region object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this region. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableRegionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableRegionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Region' + description: '' + patch: + operationId: dcim_regions_partial_update + description: Patch a region object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this region. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableRegionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableRegionRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Region' + description: '' + delete: + operationId: dcim_regions_destroy + description: Delete a region object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this region. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/site-groups/: + get: + operationId: dcim_site_groups_list + description: Get a list of site group objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + description: Parent site group (slug) + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + description: Parent site group (slug) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent site group (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent site group (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSiteGroupList' + description: '' + post: + operationId: dcim_site_groups_create + description: Post a list of site group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableSiteGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableSiteGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableSiteGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableSiteGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteGroup' + description: '' + put: + operationId: dcim_site_groups_bulk_update + description: Put a list of site group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroup' + description: '' + patch: + operationId: dcim_site_groups_bulk_partial_update + description: Patch a list of site group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroup' + description: '' + delete: + operationId: dcim_site_groups_bulk_destroy + description: Delete a list of site group objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SiteGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/site-groups/{id}/: + get: + operationId: dcim_site_groups_retrieve + description: Get a site group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site group. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteGroup' + description: '' + put: + operationId: dcim_site_groups_update + description: Put a site group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site group. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableSiteGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableSiteGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteGroup' + description: '' + patch: + operationId: dcim_site_groups_partial_update + description: Patch a site group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site group. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableSiteGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableSiteGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SiteGroup' + description: '' + delete: + operationId: dcim_site_groups_destroy + description: Delete a site group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site group. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/sites/: + get: + operationId: dcim_sites_list + description: Get a list of site objects. + parameters: + - in: query + name: asn + schema: + type: array + items: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + description: AS (ID) + explode: true + style: form + - in: query + name: asn__n + schema: + type: array + items: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + description: AS (ID) + explode: true + style: form + - in: query + name: asn_id + schema: + type: array + items: + type: integer + description: AS (ID) + explode: true + style: form + - in: query + name: asn_id__n + schema: + type: array + items: + type: integer + description: AS (ID) + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__empty + schema: + type: boolean + - in: query + name: facility__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: facility__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: latitude + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__empty + schema: + type: boolean + - in: query + name: latitude__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: latitude__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: longitude + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__empty + schema: + type: boolean + - in: query + name: longitude__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: longitude__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 1cf60831fbb35e7f + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: time_zone + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: time_zone__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSiteList' + description: '' + post: + operationId: dcim_sites_create + description: Post a list of site objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableSiteRequest' + - type: array + items: + $ref: '#/components/schemas/WritableSiteRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableSiteRequest' + - type: array + items: + $ref: '#/components/schemas/WritableSiteRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Site' + description: '' + put: + operationId: dcim_sites_bulk_update + description: Put a list of site objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SiteRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Site' + description: '' + patch: + operationId: dcim_sites_bulk_partial_update + description: Patch a list of site objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SiteRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Site' + description: '' + delete: + operationId: dcim_sites_bulk_destroy + description: Delete a list of site objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SiteRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SiteRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/sites/{id}/: + get: + operationId: dcim_sites_retrieve + description: Get a site object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Site' + description: '' + put: + operationId: dcim_sites_update + description: Put a site object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableSiteRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableSiteRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Site' + description: '' + patch: + operationId: dcim_sites_partial_update + description: Patch a site object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableSiteRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableSiteRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Site' + description: '' + delete: + operationId: dcim_sites_destroy + description: Delete a site object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this site. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/virtual-chassis/: + get: + operationId: dcim_virtual_chassis_list + description: Get a list of virtual chassis objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__empty + schema: + type: boolean + - in: query + name: domain__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: domain__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: master + schema: + type: array + items: + type: string + nullable: true + description: Master (name) + explode: true + style: form + - in: query + name: master__n + schema: + type: array + items: + type: string + nullable: true + description: Master (name) + explode: true + style: form + - in: query + name: master_id + schema: + type: array + items: + type: integer + nullable: true + description: Master (ID) + explode: true + style: form + - in: query + name: master_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Master (ID) + explode: true + style: form + - in: query + name: member_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_count__empty + schema: + type: boolean + - in: query + name: member_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: member_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site name (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualChassisList' + description: '' + post: + operationId: dcim_virtual_chassis_create + description: Post a list of virtual chassis objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualChassisRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualChassisRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualChassisRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualChassisRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualChassis' + description: '' + put: + operationId: dcim_virtual_chassis_bulk_update + description: Put a list of virtual chassis objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassisRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassisRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassis' + description: '' + patch: + operationId: dcim_virtual_chassis_bulk_partial_update + description: Patch a list of virtual chassis objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassisRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassisRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassis' + description: '' + delete: + operationId: dcim_virtual_chassis_bulk_destroy + description: Delete a list of virtual chassis objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassisRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualChassisRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/virtual-chassis/{id}/: + get: + operationId: dcim_virtual_chassis_retrieve + description: Get a virtual chassis object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual chassis. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualChassis' + description: '' + put: + operationId: dcim_virtual_chassis_update + description: Put a virtual chassis object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual chassis. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVirtualChassisRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVirtualChassisRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualChassis' + description: '' + patch: + operationId: dcim_virtual_chassis_partial_update + description: Patch a virtual chassis object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual chassis. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualChassisRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualChassisRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualChassis' + description: '' + delete: + operationId: dcim_virtual_chassis_destroy + description: Delete a virtual chassis object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual chassis. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/virtual-device-contexts/: + get: + operationId: dcim_virtual_device_contexts_list + description: Get a list of virtual device context objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: integer + description: Device model + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: integer + description: Device model + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: VDC (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: VDC (ID) + explode: true + style: form + - in: query + name: has_primary_ip + schema: + type: boolean + description: Has a primary IP + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__empty + schema: + type: boolean + - in: query + name: identifier__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: primary_ip4 + schema: + type: array + items: + type: string + description: Primary IPv4 (address) + explode: true + style: form + - in: query + name: primary_ip4__n + schema: + type: array + items: + type: string + description: Primary IPv4 (address) + explode: true + style: form + - in: query + name: primary_ip4_id + schema: + type: array + items: + type: integer + description: Primary IPv4 (ID) + explode: true + style: form + - in: query + name: primary_ip4_id__n + schema: + type: array + items: + type: integer + description: Primary IPv4 (ID) + explode: true + style: form + - in: query + name: primary_ip6 + schema: + type: array + items: + type: string + description: Primary IPv6 (address) + explode: true + style: form + - in: query + name: primary_ip6__n + schema: + type: array + items: + type: string + description: Primary IPv6 (address) + explode: true + style: form + - in: query + name: primary_ip6_id + schema: + type: array + items: + type: integer + description: Primary IPv6 (ID) + explode: true + style: form + - in: query + name: primary_ip6_id__n + schema: + type: array + items: + type: integer + description: Primary IPv6 (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0e2c0919d51b83cb + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualDeviceContextList' + description: '' + post: + operationId: dcim_virtual_device_contexts_create + description: Post a list of virtual device context objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDeviceContext' + description: '' + put: + operationId: dcim_virtual_device_contexts_bulk_update + description: Put a list of virtual device context objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContext' + description: '' + patch: + operationId: dcim_virtual_device_contexts_bulk_partial_update + description: Patch a list of virtual device context objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContext' + description: '' + delete: + operationId: dcim_virtual_device_contexts_bulk_destroy + description: Delete a list of virtual device context objects. + tags: + - dcim + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/dcim/virtual-device-contexts/{id}/: + get: + operationId: dcim_virtual_device_contexts_retrieve + description: Get a virtual device context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual device context. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDeviceContext' + description: '' + put: + operationId: dcim_virtual_device_contexts_update + description: Put a virtual device context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual device context. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDeviceContext' + description: '' + patch: + operationId: dcim_virtual_device_contexts_partial_update + description: Patch a virtual device context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual device context. + required: true + tags: + - dcim + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualDeviceContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualDeviceContextRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDeviceContext' + description: '' + delete: + operationId: dcim_virtual_device_contexts_destroy + description: Delete a virtual device context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual device context. + required: true + tags: + - dcim + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/bookmarks/: + get: + operationId: extras_bookmarks_list + description: Get a list of bookmark objects. + parameters: + - in: query + name: created + schema: + type: string + format: date-time + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__empty + schema: + type: boolean + - in: query + name: object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type_id__empty + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: user + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedBookmarkList' + description: '' + post: + operationId: extras_bookmarks_create + description: Post a list of bookmark objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/BookmarkRequest' + - type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/BookmarkRequest' + - type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Bookmark' + description: '' + put: + operationId: extras_bookmarks_bulk_update + description: Put a list of bookmark objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Bookmark' + description: '' + patch: + operationId: extras_bookmarks_bulk_partial_update + description: Patch a list of bookmark objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Bookmark' + description: '' + delete: + operationId: extras_bookmarks_bulk_destroy + description: Delete a list of bookmark objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/BookmarkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/bookmarks/{id}/: + get: + operationId: extras_bookmarks_retrieve + description: Get a bookmark object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this bookmark. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bookmark' + description: '' + put: + operationId: extras_bookmarks_update + description: Put a bookmark object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this bookmark. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BookmarkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/BookmarkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bookmark' + description: '' + patch: + operationId: extras_bookmarks_partial_update + description: Patch a bookmark object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this bookmark. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedBookmarkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedBookmarkRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Bookmark' + description: '' + delete: + operationId: extras_bookmarks_destroy + description: Delete a bookmark object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this bookmark. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/config-context-profiles/: + get: + operationId: extras_config_context_profiles_list + description: Get a list of config context profile objects. + parameters: + - in: query + name: auto_sync_enabled + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: data_file_id + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_file_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_source_id + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_source_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_synced + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__empty + schema: + type: boolean + - in: query + name: data_synced__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConfigContextProfileList' + description: '' + post: + operationId: extras_config_context_profiles_create + description: Post a list of config context profile objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ConfigContextProfileRequest' + - type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ConfigContextProfileRequest' + - type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextProfile' + description: '' + put: + operationId: extras_config_context_profiles_bulk_update + description: Put a list of config context profile objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfile' + description: '' + patch: + operationId: extras_config_context_profiles_bulk_partial_update + description: Patch a list of config context profile objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfile' + description: '' + delete: + operationId: extras_config_context_profiles_bulk_destroy + description: Delete a list of config context profile objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/config-context-profiles/{id}/: + get: + operationId: extras_config_context_profiles_retrieve + description: Get a config context profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context profile. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextProfile' + description: '' + put: + operationId: extras_config_context_profiles_update + description: Put a config context profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context profile. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextProfileRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfigContextProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextProfile' + description: '' + patch: + operationId: extras_config_context_profiles_partial_update + description: Patch a config context profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context profile. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedConfigContextProfileRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfigContextProfileRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextProfile' + description: '' + delete: + operationId: extras_config_context_profiles_destroy + description: Delete a config context profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context profile. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/config-context-profiles/{id}/sync/: + post: + operationId: extras_config_context_profiles_sync_create + description: Provide a /sync API endpoint to synchronize an object's data from + its associated DataFile (if any). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context profile. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextProfileRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfigContextProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextProfile' + description: '' + /api/extras/config-contexts/: + get: + operationId: extras_config_contexts_list + description: Get a list of config context objects. + parameters: + - in: query + name: auto_sync_enabled + schema: + type: boolean + - in: query + name: cluster_group + schema: + type: array + items: + type: string + description: Cluster group (slug) + explode: true + style: form + - in: query + name: cluster_group__n + schema: + type: array + items: + type: string + description: Cluster group (slug) + explode: true + style: form + - in: query + name: cluster_group_id + schema: + type: array + items: + type: integer + description: Cluster group + explode: true + style: form + - in: query + name: cluster_group_id__n + schema: + type: array + items: + type: integer + description: Cluster group + explode: true + style: form + - in: query + name: cluster_id + schema: + type: array + items: + type: integer + description: Cluster + explode: true + style: form + - in: query + name: cluster_id__n + schema: + type: array + items: + type: integer + description: Cluster + explode: true + style: form + - in: query + name: cluster_type + schema: + type: array + items: + type: string + description: Cluster type (slug) + explode: true + style: form + - in: query + name: cluster_type__n + schema: + type: array + items: + type: string + description: Cluster type (slug) + explode: true + style: form + - in: query + name: cluster_type_id + schema: + type: array + items: + type: integer + description: Cluster type + explode: true + style: form + - in: query + name: cluster_type_id__n + schema: + type: array + items: + type: integer + description: Cluster type + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: data_file_id + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_file_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_source_id + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_source_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_synced + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__empty + schema: + type: boolean + - in: query + name: data_synced__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: device_role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: device_role_id + schema: + type: array + items: + type: integer + description: Role + explode: true + style: form + - in: query + name: device_role_id__n + schema: + type: array + items: + type: integer + description: Role + explode: true + style: form + - in: query + name: device_type_id + schema: + type: array + items: + type: integer + description: Device type + explode: true + style: form + - in: query + name: device_type_id__n + schema: + type: array + items: + type: integer + description: Device type + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: is_active + schema: + type: boolean + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + description: Location (slug) + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: integer + description: Location + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: integer + description: Location + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: platform + schema: + type: array + items: + type: string + description: Platform (slug) + explode: true + style: form + - in: query + name: platform__n + schema: + type: array + items: + type: string + description: Platform (slug) + explode: true + style: form + - in: query + name: platform_id + schema: + type: array + items: + type: integer + description: Platform + explode: true + style: form + - in: query + name: platform_id__n + schema: + type: array + items: + type: integer + description: Platform + explode: true + style: form + - in: query + name: profile + schema: + type: array + items: + type: string + description: Profile (name) + explode: true + style: form + - in: query + name: profile__n + schema: + type: array + items: + type: string + description: Profile (name) + explode: true + style: form + - in: query + name: profile_id + schema: + type: array + items: + type: integer + nullable: true + description: Profile (ID) + explode: true + style: form + - in: query + name: profile_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Profile (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + description: Region (slug) + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + description: Region (slug) + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: integer + description: Region + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: integer + description: Region + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + description: Site group (slug) + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + description: Site group (slug) + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: integer + description: Site group + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: integer + description: Site group + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + description: Tag (slug) + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + description: Tag (slug) + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + description: Tag + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + description: Tag + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + description: Tenant group (slug) + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + description: Tenant group (slug) + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: integer + description: Tenant group + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: integer + description: Tenant group + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + description: Tenant + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + description: Tenant + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConfigContextList' + description: '' + post: + operationId: extras_config_contexts_create + description: Post a list of config context objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ConfigContextRequest' + - type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ConfigContextRequest' + - type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContext' + description: '' + put: + operationId: extras_config_contexts_bulk_update + description: Put a list of config context objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContext' + description: '' + patch: + operationId: extras_config_contexts_bulk_partial_update + description: Patch a list of config context objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContext' + description: '' + delete: + operationId: extras_config_contexts_bulk_destroy + description: Delete a list of config context objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/config-contexts/{id}/: + get: + operationId: extras_config_contexts_retrieve + description: Get a config context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContext' + description: '' + put: + operationId: extras_config_contexts_update + description: Put a config context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContext' + description: '' + patch: + operationId: extras_config_contexts_partial_update + description: Patch a config context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfigContextRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContext' + description: '' + delete: + operationId: extras_config_contexts_destroy + description: Delete a config context object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/config-contexts/{id}/sync/: + post: + operationId: extras_config_contexts_sync_create + description: Provide a /sync API endpoint to synchronize an object's data from + its associated DataFile (if any). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config context. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigContext' + description: '' + /api/extras/config-templates/: + get: + operationId: extras_config_templates_list + description: Get a list of config template objects. + parameters: + - in: query + name: as_attachment + schema: + type: boolean + - in: query + name: auto_sync_enabled + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: data_file_id + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_file_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_source_id + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_source_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_synced + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__empty + schema: + type: boolean + - in: query + name: data_synced__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: debug + schema: + type: boolean + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__empty + schema: + type: boolean + - in: query + name: file_extension__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__empty + schema: + type: boolean + - in: query + name: file_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mime_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__empty + schema: + type: boolean + - in: query + name: mime_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConfigTemplateList' + description: '' + post: + operationId: extras_config_templates_create + description: Post a list of config template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ConfigTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ConfigTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + put: + operationId: extras_config_templates_bulk_update + description: Put a list of config template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + patch: + operationId: extras_config_templates_bulk_partial_update + description: Patch a list of config template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + delete: + operationId: extras_config_templates_bulk_destroy + description: Delete a list of config template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/config-templates/{id}/: + get: + operationId: extras_config_templates_retrieve + description: Get a config template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config template. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + put: + operationId: extras_config_templates_update + description: Put a config template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config template. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfigTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + patch: + operationId: extras_config_templates_partial_update + description: Patch a config template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config template. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedConfigTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfigTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + delete: + operationId: extras_config_templates_destroy + description: Delete a config template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config template. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/config-templates/{id}/render/: + post: + operationId: extras_config_templates_render_create + description: |- + Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data, + return the raw rendered content, rather than serialized JSON. + parameters: + - in: query + name: format + schema: + type: string + enum: + - json + - txt + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config template. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfigTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplate' + text/plain: + schema: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + /api/extras/config-templates/{id}/sync/: + post: + operationId: extras_config_templates_sync_create + description: Provide a /sync API endpoint to synchronize an object's data from + its associated DataFile (if any). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this config template. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfigTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigTemplate' + description: '' + /api/extras/custom-field-choice-sets/: + get: + operationId: extras_custom_field_choice_sets_list + description: Get a list of custom field choice set objects. + parameters: + - in: query + name: base_choices + schema: + type: string + x-spec-enum-id: cf0efb5195f85007 + nullable: true + enum: + - IATA + - ISO_3166 + - UN_LOCODE + - 'null' + description: |- + Base set of predefined choices (optional) + + * `IATA` - IATA (Airport codes) + * `ISO_3166` - ISO 3166 (Country codes) + * `UN_LOCODE` - UN/LOCODE (Location codes) + - in: query + name: base_choices__empty + schema: + type: boolean + - in: query + name: base_choices__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__n + schema: + type: string + x-spec-enum-id: cf0efb5195f85007 + nullable: true + enum: + - IATA + - ISO_3166 + - UN_LOCODE + - 'null' + description: |- + Base set of predefined choices (optional) + + * `IATA` - IATA (Airport codes) + * `ISO_3166` - ISO 3166 (Country codes) + * `UN_LOCODE` - UN/LOCODE (Location codes) + - in: query + name: base_choices__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: base_choices__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: choice + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: choice_colors + schema: + type: array + items: {} + description: Choice colors + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - in: query + name: order_alphabetically + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCustomFieldChoiceSetList' + description: '' + post: + operationId: extras_custom_field_choice_sets_create + description: Post a list of custom field choice set objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldChoiceSet' + description: '' + put: + operationId: extras_custom_field_choice_sets_bulk_update + description: Put a list of custom field choice set objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSetRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSet' + description: '' + patch: + operationId: extras_custom_field_choice_sets_bulk_partial_update + description: Patch a list of custom field choice set objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSetRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSet' + description: '' + delete: + operationId: extras_custom_field_choice_sets_bulk_destroy + description: Delete a list of custom field choice set objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSetRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/custom-field-choice-sets/{id}/: + get: + operationId: extras_custom_field_choice_sets_retrieve + description: Get a custom field choice set object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field choice set. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldChoiceSet' + description: '' + put: + operationId: extras_custom_field_choice_sets_update + description: Put a custom field choice set object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field choice set. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableCustomFieldChoiceSetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldChoiceSet' + description: '' + patch: + operationId: extras_custom_field_choice_sets_partial_update + description: Patch a custom field choice set object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field choice set. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableCustomFieldChoiceSetRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableCustomFieldChoiceSetRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldChoiceSet' + description: '' + delete: + operationId: extras_custom_field_choice_sets_destroy + description: Delete a custom field choice set object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field choice set. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/custom-field-choice-sets/{id}/choices/: + get: + operationId: extras_custom_field_choice_sets_choices_retrieve + description: Provides an endpoint to iterate through each choice in a set. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field choice set. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldChoiceSet' + description: '' + /api/extras/custom-fields/: + get: + operationId: extras_custom_fields_list + description: Get a list of custom field objects. + parameters: + - in: query + name: choice_set + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: choice_set__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: choice_set_id + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - in: query + name: choice_set_id__n + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic + schema: + type: string + x-spec-enum-id: d168820c798ae45a + enum: + - disabled + - exact + - loose + - 'null' + description: |- + Loose matches any instance of a given string; exact matches the entire field. + + * `disabled` - Disabled + * `loose` - Loose + * `exact` - Exact + - in: query + name: filter_logic__empty + schema: + type: boolean + - in: query + name: filter_logic__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__n + schema: + type: string + x-spec-enum-id: d168820c798ae45a + enum: + - disabled + - exact + - loose + - 'null' + description: |- + Loose matches any instance of a given string; exact matches the entire field. + + * `disabled` - Disabled + * `loose` - Loose + * `exact` - Exact + - in: query + name: filter_logic__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: filter_logic__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__empty + schema: + type: boolean + - in: query + name: group_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: is_cloneable + schema: + type: boolean + - in: query + name: label + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__empty + schema: + type: boolean + - in: query + name: label__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: label__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: related_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: related_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: related_object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: related_object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: required + schema: + type: boolean + - in: query + name: search_weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: search_weight__empty + schema: + type: boolean + - in: query + name: search_weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: search_weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: search_weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: search_weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: search_weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 47c52a3d983e924c + description: The type of data this custom field holds + explode: true + style: form + - in: query + name: ui_editable + schema: + type: string + x-spec-enum-id: 336f52760e62022f + enum: + - hidden + - 'no' + - 'null' + - 'yes' + description: |- + Specifies whether the custom field value can be edited in the UI + + * `yes` - Yes + * `no` - No + * `hidden` - Hidden + - in: query + name: ui_editable__empty + schema: + type: boolean + - in: query + name: ui_editable__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__n + schema: + type: string + x-spec-enum-id: 336f52760e62022f + enum: + - hidden + - 'no' + - 'null' + - 'yes' + description: |- + Specifies whether the custom field value can be edited in the UI + + * `yes` - Yes + * `no` - No + * `hidden` - Hidden + - in: query + name: ui_editable__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_editable__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible + schema: + type: string + x-spec-enum-id: f32800c399b927b6 + enum: + - always + - hidden + - if-set + - 'null' + description: |- + Specifies whether the custom field is displayed in the UI + + * `always` - Always + * `if-set` - If set + * `hidden` - Hidden + - in: query + name: ui_visible__empty + schema: + type: boolean + - in: query + name: ui_visible__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__n + schema: + type: string + x-spec-enum-id: f32800c399b927b6 + enum: + - always + - hidden + - if-set + - 'null' + description: |- + Specifies whether the custom field is displayed in the UI + + * `always` - Always + * `if-set` - If set + * `hidden` - Hidden + - in: query + name: ui_visible__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ui_visible__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: unique + schema: + type: boolean + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: validation_maximum + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_maximum__empty + schema: + type: boolean + - in: query + name: validation_maximum__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_maximum__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_maximum__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_maximum__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_maximum__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_minimum + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_minimum__empty + schema: + type: boolean + - in: query + name: validation_minimum__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_minimum__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_minimum__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_minimum__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_minimum__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: validation_regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__empty + schema: + type: boolean + - in: query + name: validation_regex__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: validation_regex__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCustomFieldList' + description: '' + post: + operationId: extras_custom_fields_create + description: Post a list of custom field objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCustomFieldRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCustomFieldRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableCustomFieldRequest' + - type: array + items: + $ref: '#/components/schemas/WritableCustomFieldRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + description: '' + put: + operationId: extras_custom_fields_bulk_update + description: Put a list of custom field objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomField' + description: '' + patch: + operationId: extras_custom_fields_bulk_partial_update + description: Patch a list of custom field objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomField' + description: '' + delete: + operationId: extras_custom_fields_bulk_destroy + description: Delete a list of custom field objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomFieldRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/custom-fields/{id}/: + get: + operationId: extras_custom_fields_retrieve + description: Get a custom field object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + description: '' + put: + operationId: extras_custom_fields_update + description: Put a custom field object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableCustomFieldRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableCustomFieldRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + description: '' + patch: + operationId: extras_custom_fields_partial_update + description: Patch a custom field object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableCustomFieldRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableCustomFieldRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + description: '' + delete: + operationId: extras_custom_fields_destroy + description: Delete a custom field object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom field. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/custom-links/: + get: + operationId: extras_custom_links_list + description: Get a list of custom link objects. + parameters: + - in: query + name: button_class + schema: + type: string + x-spec-enum-id: 5e54b3bd086685ce + enum: + - black + - blue + - cyan + - default + - ghost-dark + - gray + - green + - indigo + - 'null' + - orange + - pink + - purple + - red + - teal + - white + - yellow + description: |- + The class of the first link in a group will be used for the dropdown button + + * `default` - Default + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + * `ghost-dark` - Link + - in: query + name: button_class__empty + schema: + type: boolean + - in: query + name: button_class__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__n + schema: + type: string + x-spec-enum-id: 5e54b3bd086685ce + enum: + - black + - blue + - cyan + - default + - ghost-dark + - gray + - green + - indigo + - 'null' + - orange + - pink + - purple + - red + - teal + - white + - yellow + description: |- + The class of the first link in a group will be used for the dropdown button + + * `default` - Default + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + * `ghost-dark` - Link + - in: query + name: button_class__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: button_class__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: enabled + schema: + type: boolean + - in: query + name: group_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__empty + schema: + type: boolean + - in: query + name: group_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: link_text + schema: + type: string + - in: query + name: link_text__ic + schema: + type: string + - in: query + name: link_text__ie + schema: + type: string + - in: query + name: link_text__iew + schema: + type: string + - in: query + name: link_text__iregex + schema: + type: string + - in: query + name: link_text__isw + schema: + type: string + - in: query + name: link_text__n + schema: + type: string + - in: query + name: link_text__nic + schema: + type: string + - in: query + name: link_text__nie + schema: + type: string + - in: query + name: link_text__niew + schema: + type: string + - in: query + name: link_text__nisw + schema: + type: string + - in: query + name: link_text__regex + schema: + type: string + - in: query + name: link_url + schema: + type: string + - in: query + name: link_url__ic + schema: + type: string + - in: query + name: link_url__ie + schema: + type: string + - in: query + name: link_url__iew + schema: + type: string + - in: query + name: link_url__iregex + schema: + type: string + - in: query + name: link_url__isw + schema: + type: string + - in: query + name: link_url__n + schema: + type: string + - in: query + name: link_url__nic + schema: + type: string + - in: query + name: link_url__nie + schema: + type: string + - in: query + name: link_url__niew + schema: + type: string + - in: query + name: link_url__nisw + schema: + type: string + - in: query + name: link_url__regex + schema: + type: string + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: new_window + schema: + type: boolean + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCustomLinkList' + description: '' + post: + operationId: extras_custom_links_create + description: Post a list of custom link objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/CustomLinkRequest' + - type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/CustomLinkRequest' + - type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomLink' + description: '' + put: + operationId: extras_custom_links_bulk_update + description: Put a list of custom link objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLink' + description: '' + patch: + operationId: extras_custom_links_bulk_partial_update + description: Patch a list of custom link objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLink' + description: '' + delete: + operationId: extras_custom_links_bulk_destroy + description: Delete a list of custom link objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CustomLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/custom-links/{id}/: + get: + operationId: extras_custom_links_retrieve + description: Get a custom link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom link. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomLink' + description: '' + put: + operationId: extras_custom_links_update + description: Put a custom link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom link. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomLinkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/CustomLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomLink' + description: '' + patch: + operationId: extras_custom_links_partial_update + description: Patch a custom link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom link. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedCustomLinkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedCustomLinkRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomLink' + description: '' + delete: + operationId: extras_custom_links_destroy + description: Delete a custom link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this custom link. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/dashboard/: + get: + operationId: extras_dashboard_retrieve + description: Get a list of dashboard objects. + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dashboard' + description: '' + put: + operationId: extras_dashboard_update + description: Put a list of dashboard objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DashboardRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/DashboardRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dashboard' + description: '' + patch: + operationId: extras_dashboard_partial_update + description: Patch a list of dashboard objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedDashboardRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedDashboardRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dashboard' + description: '' + delete: + operationId: extras_dashboard_destroy + description: Delete a list of dashboard objects. + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/event-rules/: + get: + operationId: extras_event_rules_list + description: Get a list of event rule objects. + parameters: + - in: query + name: action_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: action_object_id__empty + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: action_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: action_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: action_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: action_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: action_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: action_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: action_type + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__empty + schema: + type: boolean + - in: query + name: action_type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: action_type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 287901b937995956 + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: event_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEventRuleList' + description: '' + post: + operationId: extras_event_rules_create + description: Post a list of event rule objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableEventRuleRequest' + - type: array + items: + $ref: '#/components/schemas/WritableEventRuleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableEventRuleRequest' + - type: array + items: + $ref: '#/components/schemas/WritableEventRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/EventRule' + description: '' + put: + operationId: extras_event_rules_bulk_update + description: Put a list of event rule objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EventRuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/EventRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EventRule' + description: '' + patch: + operationId: extras_event_rules_bulk_partial_update + description: Patch a list of event rule objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EventRuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/EventRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EventRule' + description: '' + delete: + operationId: extras_event_rules_bulk_destroy + description: Delete a list of event rule objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EventRuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/EventRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/event-rules/{id}/: + get: + operationId: extras_event_rules_retrieve + description: Get a event rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event rule. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventRule' + description: '' + put: + operationId: extras_event_rules_update + description: Put a event rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event rule. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableEventRuleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableEventRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventRule' + description: '' + patch: + operationId: extras_event_rules_partial_update + description: Patch a event rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event rule. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableEventRuleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableEventRuleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventRule' + description: '' + delete: + operationId: extras_event_rules_destroy + description: Delete a event rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event rule. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/export-templates/: + get: + operationId: extras_export_templates_list + description: Get a list of export template objects. + parameters: + - in: query + name: as_attachment + schema: + type: boolean + - in: query + name: auto_sync_enabled + schema: + type: boolean + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: data_file_id + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_file_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data file (ID) + explode: true + style: form + - in: query + name: data_source_id + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_source_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Data source (ID) + explode: true + style: form + - in: query + name: data_synced + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__empty + schema: + type: boolean + - in: query + name: data_synced__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: data_synced__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__empty + schema: + type: boolean + - in: query + name: file_extension__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_extension__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__empty + schema: + type: boolean + - in: query + name: file_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: file_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mime_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__empty + schema: + type: boolean + - in: query + name: mime_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mime_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedExportTemplateList' + description: '' + post: + operationId: extras_export_templates_create + description: Post a list of export template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ExportTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ExportTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExportTemplate' + description: '' + put: + operationId: extras_export_templates_bulk_update + description: Put a list of export template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplate' + description: '' + patch: + operationId: extras_export_templates_bulk_partial_update + description: Patch a list of export template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplate' + description: '' + delete: + operationId: extras_export_templates_bulk_destroy + description: Delete a list of export template objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ExportTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/export-templates/{id}/: + get: + operationId: extras_export_templates_retrieve + description: Get a export template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this export template. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExportTemplate' + description: '' + put: + operationId: extras_export_templates_update + description: Put a export template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this export template. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExportTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExportTemplate' + description: '' + patch: + operationId: extras_export_templates_partial_update + description: Patch a export template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this export template. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedExportTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedExportTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExportTemplate' + description: '' + delete: + operationId: extras_export_templates_destroy + description: Delete a export template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this export template. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/export-templates/{id}/sync/: + post: + operationId: extras_export_templates_sync_create + description: Provide a /sync API endpoint to synchronize an object's data from + its associated DataFile (if any). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this export template. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ExportTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExportTemplate' + description: '' + /api/extras/image-attachments/: + get: + operationId: extras_image_attachments_list + description: Get a list of image attachment objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_height + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_height__empty + schema: + type: boolean + - in: query + name: image_height__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_height__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_height__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_height__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_height__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_width + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_width__empty + schema: + type: boolean + - in: query + name: image_width__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_width__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_width__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_width__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: image_width__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__empty + schema: + type: boolean + - in: query + name: object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: integer + - in: query + name: object_type_id__n + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedImageAttachmentList' + description: '' + post: + operationId: extras_image_attachments_create + description: Post a list of image attachment objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ImageAttachmentRequest' + - type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ImageAttachmentRequest' + - type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ImageAttachment' + description: '' + put: + operationId: extras_image_attachments_bulk_update + description: Put a list of image attachment objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachment' + description: '' + patch: + operationId: extras_image_attachments_bulk_partial_update + description: Patch a list of image attachment objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachment' + description: '' + delete: + operationId: extras_image_attachments_bulk_destroy + description: Delete a list of image attachment objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ImageAttachmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/image-attachments/{id}/: + get: + operationId: extras_image_attachments_retrieve + description: Get a image attachment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this image attachment. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ImageAttachment' + description: '' + put: + operationId: extras_image_attachments_update + description: Put a image attachment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this image attachment. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageAttachmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ImageAttachmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ImageAttachment' + description: '' + patch: + operationId: extras_image_attachments_partial_update + description: Patch a image attachment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this image attachment. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedImageAttachmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedImageAttachmentRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ImageAttachment' + description: '' + delete: + operationId: extras_image_attachments_destroy + description: Delete a image attachment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this image attachment. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/journal-entries/: + get: + operationId: extras_journal_entries_list + description: Get a list of journal entry objects. + parameters: + - in: query + name: assigned_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__empty + schema: + type: boolean + - in: query + name: assigned_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned_object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: assigned_object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: created_after + schema: + type: string + format: date-time + - in: query + name: created_before + schema: + type: string + format: date-time + - in: query + name: created_by + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: created_by__n + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: created_by_id + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: created_by_id__n + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: kind + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__empty + schema: + type: boolean + - in: query + name: kind__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__n + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: kind__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 6f65abe0aab2c78c + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedJournalEntryList' + description: '' + post: + operationId: extras_journal_entries_create + description: Post a list of journal entry objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableJournalEntryRequest' + - type: array + items: + $ref: '#/components/schemas/WritableJournalEntryRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableJournalEntryRequest' + - type: array + items: + $ref: '#/components/schemas/WritableJournalEntryRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/JournalEntry' + description: '' + put: + operationId: extras_journal_entries_bulk_update + description: Put a list of journal entry objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntryRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntryRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntry' + description: '' + patch: + operationId: extras_journal_entries_bulk_partial_update + description: Patch a list of journal entry objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntryRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntryRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntry' + description: '' + delete: + operationId: extras_journal_entries_bulk_destroy + description: Delete a list of journal entry objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntryRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/JournalEntryRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/journal-entries/{id}/: + get: + operationId: extras_journal_entries_retrieve + description: Get a journal entry object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this journal entry. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JournalEntry' + description: '' + put: + operationId: extras_journal_entries_update + description: Put a journal entry object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this journal entry. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableJournalEntryRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableJournalEntryRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JournalEntry' + description: '' + patch: + operationId: extras_journal_entries_partial_update + description: Patch a journal entry object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this journal entry. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableJournalEntryRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableJournalEntryRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/JournalEntry' + description: '' + delete: + operationId: extras_journal_entries_destroy + description: Delete a journal entry object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this journal entry. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/notification-groups/: + get: + operationId: extras_notification_groups_list + description: Get a list of notification group objects. + parameters: + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNotificationGroupList' + description: '' + post: + operationId: extras_notification_groups_create + description: Post a list of notification group objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NotificationGroupRequest' + - type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/NotificationGroupRequest' + - type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationGroup' + description: '' + put: + operationId: extras_notification_groups_bulk_update + description: Put a list of notification group objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroup' + description: '' + patch: + operationId: extras_notification_groups_bulk_partial_update + description: Patch a list of notification group objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroup' + description: '' + delete: + operationId: extras_notification_groups_bulk_destroy + description: Delete a list of notification group objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/notification-groups/{id}/: + get: + operationId: extras_notification_groups_retrieve + description: Get a notification group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification group. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationGroup' + description: '' + put: + operationId: extras_notification_groups_update + description: Put a notification group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification group. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/NotificationGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationGroup' + description: '' + patch: + operationId: extras_notification_groups_partial_update + description: Patch a notification group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification group. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNotificationGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNotificationGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationGroup' + description: '' + delete: + operationId: extras_notification_groups_destroy + description: Delete a notification group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification group. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/notifications/: + get: + operationId: extras_notifications_list + description: Get a list of notification objects. + parameters: + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNotificationList' + description: '' + post: + operationId: extras_notifications_create + description: Post a list of notification objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NotificationRequest' + - type: array + items: + $ref: '#/components/schemas/NotificationRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/NotificationRequest' + - type: array + items: + $ref: '#/components/schemas/NotificationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + description: '' + put: + operationId: extras_notifications_bulk_update + description: Put a list of notification objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Notification' + description: '' + patch: + operationId: extras_notifications_bulk_partial_update + description: Patch a list of notification objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Notification' + description: '' + delete: + operationId: extras_notifications_bulk_destroy + description: Delete a list of notification objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/notifications/{id}/: + get: + operationId: extras_notifications_retrieve + description: Get a notification object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + description: '' + put: + operationId: extras_notifications_update + description: Put a notification object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/NotificationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + description: '' + patch: + operationId: extras_notifications_partial_update + description: Patch a notification object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNotificationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNotificationRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' + description: '' + delete: + operationId: extras_notifications_destroy + description: Delete a notification object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this notification. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/saved-filters/: + get: + operationId: extras_saved_filters_list + description: Get a list of saved filter objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: shared + schema: + type: boolean + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: usable + schema: + type: boolean + - in: query + name: user + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSavedFilterList' + description: '' + post: + operationId: extras_saved_filters_create + description: Post a list of saved filter objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SavedFilterRequest' + - type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/SavedFilterRequest' + - type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SavedFilter' + description: '' + put: + operationId: extras_saved_filters_bulk_update + description: Put a list of saved filter objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilter' + description: '' + patch: + operationId: extras_saved_filters_bulk_partial_update + description: Patch a list of saved filter objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilter' + description: '' + delete: + operationId: extras_saved_filters_bulk_destroy + description: Delete a list of saved filter objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SavedFilterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/saved-filters/{id}/: + get: + operationId: extras_saved_filters_retrieve + description: Get a saved filter object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this saved filter. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SavedFilter' + description: '' + put: + operationId: extras_saved_filters_update + description: Put a saved filter object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this saved filter. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SavedFilterRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SavedFilterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SavedFilter' + description: '' + patch: + operationId: extras_saved_filters_partial_update + description: Patch a saved filter object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this saved filter. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedSavedFilterRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedSavedFilterRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SavedFilter' + description: '' + delete: + operationId: extras_saved_filters_destroy + description: Delete a saved filter object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this saved filter. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/scripts/: + get: + operationId: extras_scripts_list + description: Get a list of script objects. + parameters: + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: is_executable + schema: + type: boolean + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: module_id + schema: + type: array + items: + type: integer + description: Script module (ID) + explode: true + style: form + - in: query + name: module_id__n + schema: + type: array + items: + type: integer + description: Script module (ID) + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedScriptList' + description: '' + post: + operationId: extras_scripts_create + description: Post a list of script objects. + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Script' + description: '' + /api/extras/scripts/{id}/: + get: + operationId: extras_scripts_retrieve + description: Get a script object. + parameters: + - in: path + name: id + schema: + type: string + pattern: ^[^/]+$ + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Script' + description: '' + put: + operationId: extras_scripts_update + description: Put a script object. + parameters: + - in: path + name: id + schema: + type: string + pattern: ^[^/]+$ + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptInputRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ScriptInputRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Script' + description: '' + patch: + operationId: extras_scripts_partial_update + description: Patch a script object. + parameters: + - in: path + name: id + schema: + type: string + pattern: ^[^/]+$ + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedScriptInputRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedScriptInputRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Script' + description: '' + delete: + operationId: extras_scripts_destroy + description: Delete a script object. + parameters: + - in: path + name: id + schema: + type: string + pattern: ^[^/]+$ + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/scripts/upload/: + post: + operationId: extras_scripts_upload_create + description: Post a list of script module objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptModuleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ScriptModuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ScriptModule' + description: '' + /api/extras/subscriptions/: + get: + operationId: extras_subscriptions_list + description: Get a list of subscription objects. + parameters: + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSubscriptionList' + description: '' + post: + operationId: extras_subscriptions_create + description: Post a list of subscription objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SubscriptionRequest' + - type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/SubscriptionRequest' + - type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + description: '' + put: + operationId: extras_subscriptions_bulk_update + description: Put a list of subscription objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Subscription' + description: '' + patch: + operationId: extras_subscriptions_bulk_partial_update + description: Patch a list of subscription objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Subscription' + description: '' + delete: + operationId: extras_subscriptions_bulk_destroy + description: Delete a list of subscription objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/subscriptions/{id}/: + get: + operationId: extras_subscriptions_retrieve + description: Get a subscription object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this subscription. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + description: '' + put: + operationId: extras_subscriptions_update + description: Put a subscription object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this subscription. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SubscriptionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + description: '' + patch: + operationId: extras_subscriptions_partial_update + description: Patch a subscription object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this subscription. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedSubscriptionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedSubscriptionRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + description: '' + delete: + operationId: extras_subscriptions_destroy + description: Delete a subscription object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this subscription. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/table-configs/: + get: + operationId: extras_table_configs_list + description: Get a list of table config objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: shared + schema: + type: boolean + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: table + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__empty + schema: + type: boolean + - in: query + name: table__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: table__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: usable + schema: + type: boolean + - in: query + name: user + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + nullable: true + description: User (ID) + explode: true + style: form + - in: query + name: weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTableConfigList' + description: '' + post: + operationId: extras_table_configs_create + description: Post a list of table config objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TableConfigRequest' + - type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/TableConfigRequest' + - type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TableConfig' + description: '' + put: + operationId: extras_table_configs_bulk_update + description: Put a list of table config objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfig' + description: '' + patch: + operationId: extras_table_configs_bulk_partial_update + description: Patch a list of table config objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfig' + description: '' + delete: + operationId: extras_table_configs_bulk_destroy + description: Delete a list of table config objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TableConfigRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/table-configs/{id}/: + get: + operationId: extras_table_configs_retrieve + description: Get a table config object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this table config. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TableConfig' + description: '' + put: + operationId: extras_table_configs_update + description: Put a table config object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this table config. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TableConfigRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TableConfigRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TableConfig' + description: '' + patch: + operationId: extras_table_configs_partial_update + description: Patch a table config object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this table config. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedTableConfigRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedTableConfigRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TableConfig' + description: '' + delete: + operationId: extras_table_configs_destroy + description: Delete a table config object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this table config. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/tagged-objects/: + get: + operationId: extras_tagged_objects_list + description: Get a list of tagged item objects. + parameters: + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__empty + schema: + type: boolean + - in: query + name: object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTaggedItemList' + description: '' + /api/extras/tagged-objects/{id}/: + get: + operationId: extras_tagged_objects_retrieve + description: Get a tagged item object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tagged item. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TaggedItem' + description: '' + /api/extras/tags/: + get: + operationId: extras_tags_list + description: Get a list of tag objects. + parameters: + - in: query + name: color + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__empty + schema: + type: boolean + - in: query + name: color__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: color__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: content_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: content_type_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: for_object_type_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_types + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_types__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTagList' + description: '' + post: + operationId: extras_tags_create + description: Post a list of tag objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TagRequest' + - type: array + items: + $ref: '#/components/schemas/TagRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/TagRequest' + - type: array + items: + $ref: '#/components/schemas/TagRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Tag' + description: '' + put: + operationId: extras_tags_bulk_update + description: Put a list of tag objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TagRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + description: '' + patch: + operationId: extras_tags_bulk_partial_update + description: Patch a list of tag objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TagRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + description: '' + delete: + operationId: extras_tags_bulk_destroy + description: Delete a list of tag objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TagRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TagRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/tags/{id}/: + get: + operationId: extras_tags_retrieve + description: Get a tag object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tag. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tag' + description: '' + put: + operationId: extras_tags_update + description: Put a tag object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tag. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TagRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tag' + description: '' + patch: + operationId: extras_tags_partial_update + description: Patch a tag object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tag. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedTagRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedTagRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tag' + description: '' + delete: + operationId: extras_tags_destroy + description: Delete a tag object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tag. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/webhooks/: + get: + operationId: extras_webhooks_list + description: Get a list of webhook objects. + parameters: + - in: query + name: ca_file_path + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__empty + schema: + type: boolean + - in: query + name: ca_file_path__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ca_file_path__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__empty + schema: + type: boolean + - in: query + name: http_content_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_content_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: http_method + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__empty + schema: + type: boolean + - in: query + name: http_method__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__n + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: http_method__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 867bf764d3b1eeaa + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: payload_url + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: secret + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__empty + schema: + type: boolean + - in: query + name: secret__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: secret__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssl_verification + schema: + type: boolean + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedWebhookList' + description: '' + post: + operationId: extras_webhooks_create + description: Post a list of webhook objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WebhookRequest' + - type: array + items: + $ref: '#/components/schemas/WebhookRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WebhookRequest' + - type: array + items: + $ref: '#/components/schemas/WebhookRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Webhook' + description: '' + put: + operationId: extras_webhooks_bulk_update + description: Put a list of webhook objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WebhookRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WebhookRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Webhook' + description: '' + patch: + operationId: extras_webhooks_bulk_partial_update + description: Patch a list of webhook objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WebhookRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WebhookRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Webhook' + description: '' + delete: + operationId: extras_webhooks_bulk_destroy + description: Delete a list of webhook objects. + tags: + - extras + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WebhookRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WebhookRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/extras/webhooks/{id}/: + get: + operationId: extras_webhooks_retrieve + description: Get a webhook object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this webhook. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Webhook' + description: '' + put: + operationId: extras_webhooks_update + description: Put a webhook object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this webhook. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WebhookRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WebhookRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Webhook' + description: '' + patch: + operationId: extras_webhooks_partial_update + description: Patch a webhook object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this webhook. + required: true + tags: + - extras + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWebhookRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWebhookRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Webhook' + description: '' + delete: + operationId: extras_webhooks_destroy + description: Delete a webhook object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this webhook. + required: true + tags: + - extras + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/aggregates/: + get: + operationId: ipam_aggregates_list + description: Get a list of aggregate objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: date_added + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: date_added__empty + schema: + type: boolean + - in: query + name: date_added__gt + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: date_added__gte + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: date_added__lt + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: date_added__lte + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: date_added__n + schema: + type: array + items: + type: string + format: date + explode: true + style: form + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: family + schema: + type: number + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: prefix + schema: + type: string + description: Prefix + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rir + schema: + type: array + items: + type: string + description: RIR (slug) + explode: true + style: form + - in: query + name: rir__n + schema: + type: array + items: + type: string + description: RIR (slug) + explode: true + style: form + - in: query + name: rir_id + schema: + type: array + items: + type: integer + description: RIR (ID) + explode: true + style: form + - in: query + name: rir_id__n + schema: + type: array + items: + type: integer + description: RIR (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedAggregateList' + description: '' + post: + operationId: ipam_aggregates_create + description: Post a list of aggregate objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableAggregateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableAggregateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableAggregateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableAggregateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Aggregate' + description: '' + put: + operationId: ipam_aggregates_bulk_update + description: Put a list of aggregate objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AggregateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/AggregateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Aggregate' + description: '' + patch: + operationId: ipam_aggregates_bulk_partial_update + description: Patch a list of aggregate objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AggregateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/AggregateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Aggregate' + description: '' + delete: + operationId: ipam_aggregates_bulk_destroy + description: Delete a list of aggregate objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AggregateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/AggregateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/aggregates/{id}/: + get: + operationId: ipam_aggregates_retrieve + description: Get a aggregate object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this aggregate. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Aggregate' + description: '' + put: + operationId: ipam_aggregates_update + description: Put a aggregate object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this aggregate. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableAggregateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableAggregateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Aggregate' + description: '' + patch: + operationId: ipam_aggregates_partial_update + description: Patch a aggregate object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this aggregate. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableAggregateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableAggregateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Aggregate' + description: '' + delete: + operationId: ipam_aggregates_destroy + description: Delete a aggregate object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this aggregate. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/asn-ranges/: + get: + operationId: ipam_asn_ranges_list + description: Get a list of ASN range objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: end + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: end__empty + schema: + type: boolean + - in: query + name: end__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: end__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: end__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: end__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: end__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rir + schema: + type: array + items: + type: string + description: RIR (slug) + explode: true + style: form + - in: query + name: rir__n + schema: + type: array + items: + type: string + description: RIR (slug) + explode: true + style: form + - in: query + name: rir_id + schema: + type: array + items: + type: integer + description: RIR (ID) + explode: true + style: form + - in: query + name: rir_id__n + schema: + type: array + items: + type: integer + description: RIR (ID) + explode: true + style: form + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: start__empty + schema: + type: boolean + - in: query + name: start__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: start__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: start__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: start__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: start__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedASNRangeList' + description: '' + post: + operationId: ipam_asn_ranges_create + description: Post a list of ASN range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ASNRangeRequest' + - type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ASNRangeRequest' + - type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ASNRange' + description: '' + put: + operationId: ipam_asn_ranges_bulk_update + description: Put a list of ASN range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRange' + description: '' + patch: + operationId: ipam_asn_ranges_bulk_partial_update + description: Patch a list of ASN range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRange' + description: '' + delete: + operationId: ipam_asn_ranges_bulk_destroy + description: Delete a list of ASN range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/asn-ranges/{id}/: + get: + operationId: ipam_asn_ranges_retrieve + description: Get a ASN range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN range. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ASNRange' + description: '' + put: + operationId: ipam_asn_ranges_update + description: Put a ASN range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN range. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ASNRangeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ASNRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ASNRange' + description: '' + patch: + operationId: ipam_asn_ranges_partial_update + description: Patch a ASN range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN range. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedASNRangeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedASNRangeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ASNRange' + description: '' + delete: + operationId: ipam_asn_ranges_destroy + description: Delete a ASN range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN range. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/asn-ranges/{id}/available-asns/: + get: + operationId: ipam_asn_ranges_available_asns_list + description: Get a ASN object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableASN' + description: '' + post: + operationId: ipam_asn_ranges_available_asns_create + description: Post a ASN object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASN' + description: '' + /api/ipam/asns/: + get: + operationId: ipam_asns_list + description: Get a list of ASN objects. + parameters: + - in: query + name: asn + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: asn__empty + schema: + type: boolean + - in: query + name: asn__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: asn__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: asn__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: asn__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: asn__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: provider + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider__n + schema: + type: array + items: + type: string + description: Provider (slug) + explode: true + style: form + - in: query + name: provider_id + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: provider_id__n + schema: + type: array + items: + type: integer + description: Provider (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rir + schema: + type: array + items: + type: string + description: RIR (slug) + explode: true + style: form + - in: query + name: rir__n + schema: + type: array + items: + type: string + description: RIR (slug) + explode: true + style: form + - in: query + name: rir_id + schema: + type: array + items: + type: integer + description: RIR (ID) + explode: true + style: form + - in: query + name: rir_id__n + schema: + type: array + items: + type: integer + description: RIR (ID) + explode: true + style: form + - in: query + name: role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedASNList' + description: '' + post: + operationId: ipam_asns_create + description: Post a list of ASN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ASNRequest' + - type: array + items: + $ref: '#/components/schemas/ASNRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ASNRequest' + - type: array + items: + $ref: '#/components/schemas/ASNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ASN' + description: '' + put: + operationId: ipam_asns_bulk_update + description: Put a list of ASN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASN' + description: '' + patch: + operationId: ipam_asns_bulk_partial_update + description: Patch a list of ASN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASN' + description: '' + delete: + operationId: ipam_asns_bulk_destroy + description: Delete a list of ASN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ASNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/asns/{id}/: + get: + operationId: ipam_asns_retrieve + description: Get a ASN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ASN' + description: '' + put: + operationId: ipam_asns_update + description: Put a ASN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ASNRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ASNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ASN' + description: '' + patch: + operationId: ipam_asns_partial_update + description: Patch a ASN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedASNRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedASNRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ASN' + description: '' + delete: + operationId: ipam_asns_destroy + description: Delete a ASN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this ASN. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/fhrp-group-assignments/: + get: + operationId: ipam_fhrp_group_assignments_list + description: Get a list of FHRP group assignment objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: device + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + description: Group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + description: Group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id__empty + schema: + type: boolean + - in: query + name: interface_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: interface_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: priority + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: priority__empty + schema: + type: boolean + - in: query + name: priority__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: priority__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: priority__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: priority__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: priority__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: virtual_machine_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedFHRPGroupAssignmentList' + description: '' + post: + operationId: ipam_fhrp_group_assignments_create + description: Post a list of FHRP group assignment objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + - type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + - type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroupAssignment' + description: '' + put: + operationId: ipam_fhrp_group_assignments_bulk_update + description: Put a list of FHRP group assignment objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignment' + description: '' + patch: + operationId: ipam_fhrp_group_assignments_bulk_partial_update + description: Patch a list of FHRP group assignment objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignment' + description: '' + delete: + operationId: ipam_fhrp_group_assignments_bulk_destroy + description: Delete a list of FHRP group assignment objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/fhrp-group-assignments/{id}/: + get: + operationId: ipam_fhrp_group_assignments_retrieve + description: Get a FHRP group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group assignment. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroupAssignment' + description: '' + put: + operationId: ipam_fhrp_group_assignments_update + description: Put a FHRP group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group assignment. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/FHRPGroupAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroupAssignment' + description: '' + patch: + operationId: ipam_fhrp_group_assignments_partial_update + description: Patch a FHRP group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group assignment. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedFHRPGroupAssignmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedFHRPGroupAssignmentRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroupAssignment' + description: '' + delete: + operationId: ipam_fhrp_group_assignments_destroy + description: Delete a FHRP group assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group assignment. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/fhrp-groups/: + get: + operationId: ipam_fhrp_groups_list + description: Get a list of FHRP group objects. + parameters: + - in: query + name: auth_key + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__empty + schema: + type: boolean + - in: query + name: auth_key__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_key__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_type + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__empty + schema: + type: boolean + - in: query + name: auth_type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: group_id__empty + schema: + type: boolean + - in: query + name: group_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: group_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: group_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: group_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: protocol + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__empty + schema: + type: boolean + - in: query + name: protocol__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__n + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: protocol__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 98de93c9f65d1c65 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: related_ip + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedFHRPGroupList' + description: '' + post: + operationId: ipam_fhrp_groups_create + description: Post a list of FHRP group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/FHRPGroupRequest' + - type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/FHRPGroupRequest' + - type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroup' + description: '' + put: + operationId: ipam_fhrp_groups_bulk_update + description: Put a list of FHRP group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroup' + description: '' + patch: + operationId: ipam_fhrp_groups_bulk_partial_update + description: Patch a list of FHRP group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroup' + description: '' + delete: + operationId: ipam_fhrp_groups_bulk_destroy + description: Delete a list of FHRP group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/FHRPGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/fhrp-groups/{id}/: + get: + operationId: ipam_fhrp_groups_retrieve + description: Get a FHRP group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroup' + description: '' + put: + operationId: ipam_fhrp_groups_update + description: Put a FHRP group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/FHRPGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroup' + description: '' + patch: + operationId: ipam_fhrp_groups_partial_update + description: Patch a FHRP group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedFHRPGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedFHRPGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FHRPGroup' + description: '' + delete: + operationId: ipam_fhrp_groups_destroy + description: Delete a FHRP group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this FHRP group. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/ip-addresses/: + get: + operationId: ipam_ip_addresses_list + description: Get a list of IP address objects. + parameters: + - in: query + name: address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned + schema: + type: boolean + description: Is assigned + - in: query + name: assigned_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__empty + schema: + type: boolean + - in: query + name: assigned_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned_to_interface + schema: + type: boolean + description: Is assigned to an interface + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: dns_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__empty + schema: + type: boolean + - in: query + name: dns_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: dns_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: family + schema: + type: number + - in: query + name: fhrpgroup_id + schema: + type: array + items: + type: integer + description: FHRP group (ID) + explode: true + style: form + - in: query + name: fhrpgroup_id__n + schema: + type: array + items: + type: integer + description: FHRP group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface__n + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mask_length + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mask_length__gte + schema: + type: number + - in: query + name: mask_length__lte + schema: + type: number + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: nat_inside_id + schema: + type: array + items: + type: integer + description: NAT inside IP address (ID) + explode: true + style: form + - in: query + name: nat_inside_id__n + schema: + type: array + items: + type: integer + description: NAT inside IP address (ID) + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: present_in_vrf + schema: + type: string + - in: query + name: present_in_vrf_id + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: role + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__empty + schema: + type: boolean + - in: query + name: role__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: role__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: The functional role of this IP + explode: true + style: form + - in: query + name: service_id + schema: + type: array + items: + type: integer + description: Application Service (ID) + explode: true + style: form + - in: query + name: service_id__n + schema: + type: array + items: + type: integer + description: Application Service (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: The operational status of this IP + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: virtual_machine_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vminterface + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface__n + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface_id + schema: + type: array + items: + type: integer + description: VM interface (ID) + explode: true + style: form + - in: query + name: vminterface_id__n + schema: + type: array + items: + type: integer + description: VM interface (ID) + explode: true + style: form + - in: query + name: vrf + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf__n + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf_id + schema: + type: array + items: + type: integer + nullable: true + description: VRF + explode: true + style: form + - in: query + name: vrf_id__n + schema: + type: array + items: + type: integer + nullable: true + description: VRF + explode: true + style: form + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedIPAddressList' + description: '' + post: + operationId: ipam_ip_addresses_create + description: Post a list of IP address objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPAddressRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPAddressRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPAddressRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IPAddress' + description: '' + put: + operationId: ipam_ip_addresses_bulk_update + description: Put a list of IP address objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddressRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddress' + description: '' + patch: + operationId: ipam_ip_addresses_bulk_partial_update + description: Patch a list of IP address objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddressRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddress' + description: '' + delete: + operationId: ipam_ip_addresses_bulk_destroy + description: Delete a list of IP address objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddressRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/ip-addresses/{id}/: + get: + operationId: ipam_ip_addresses_retrieve + description: Get a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP address. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPAddress' + description: '' + put: + operationId: ipam_ip_addresses_update + description: Put a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP address. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableIPAddressRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableIPAddressRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPAddress' + description: '' + patch: + operationId: ipam_ip_addresses_partial_update + description: Patch a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP address. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableIPAddressRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableIPAddressRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPAddress' + description: '' + delete: + operationId: ipam_ip_addresses_destroy + description: Delete a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP address. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/ip-ranges/: + get: + operationId: ipam_ip_ranges_list + description: Get a list of IP range objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contains + schema: + type: string + description: Ranges which contain this prefix or IP + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: end_address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: family + schema: + type: number + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mark_populated + schema: + type: boolean + - in: query + name: mark_utilized + schema: + type: boolean + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: size + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__empty + schema: + type: boolean + - in: query + name: size__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: start_address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this range + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vrf + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf__n + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf_id + schema: + type: array + items: + type: integer + nullable: true + description: VRF + explode: true + style: form + - in: query + name: vrf_id__n + schema: + type: array + items: + type: integer + nullable: true + description: VRF + explode: true + style: form + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedIPRangeList' + description: '' + post: + operationId: ipam_ip_ranges_create + description: Post a list of IP range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPRangeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPRangeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPRangeRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IPRange' + description: '' + put: + operationId: ipam_ip_ranges_bulk_update + description: Put a list of IP range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPRangeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPRange' + description: '' + patch: + operationId: ipam_ip_ranges_bulk_partial_update + description: Patch a list of IP range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPRangeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPRange' + description: '' + delete: + operationId: ipam_ip_ranges_bulk_destroy + description: Delete a list of IP range objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPRangeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/ip-ranges/{id}/: + get: + operationId: ipam_ip_ranges_retrieve + description: Get a IP range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP range. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPRange' + description: '' + put: + operationId: ipam_ip_ranges_update + description: Put a IP range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP range. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableIPRangeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableIPRangeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPRange' + description: '' + patch: + operationId: ipam_ip_ranges_partial_update + description: Patch a IP range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP range. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableIPRangeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableIPRangeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPRange' + description: '' + delete: + operationId: ipam_ip_ranges_destroy + description: Delete a IP range object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IP range. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/ip-ranges/{id}/available-ips/: + get: + operationId: ipam_ip_ranges_available_ips_list + description: Get a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableIP' + description: '' + post: + operationId: ipam_ip_ranges_available_ips_create + description: Post a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableIPRequestRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableIPRequestRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddress' + description: '' + /api/ipam/prefixes/: + get: + operationId: ipam_prefixes_list + description: Get a list of prefix objects. + parameters: + - in: query + name: children + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: children__empty + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: children__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: children__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: children__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: children__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: children__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contains + schema: + type: string + description: Prefixes which contain this prefix or IP + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: depth + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: depth__empty + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: depth__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: depth__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: depth__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: depth__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: depth__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: family + schema: + type: number + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: is_pool + schema: + type: boolean + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mark_utilized + schema: + type: boolean + - in: query + name: mask_length + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mask_length__gte + schema: + type: number + - in: query + name: mask_length__lte + schema: + type: number + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: prefix + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: present_in_vrf + schema: + type: string + - in: query + name: present_in_vrf_id + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: scope_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__empty + schema: + type: boolean + - in: query + name: scope_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: scope_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: Operational status of this prefix + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vlan_group + schema: + type: array + items: + type: string + description: VLAN Group (slug) + explode: true + style: form + - in: query + name: vlan_group__n + schema: + type: array + items: + type: string + description: VLAN Group (slug) + explode: true + style: form + - in: query + name: vlan_group_id + schema: + type: array + items: + type: integer + description: VLAN Group (ID) + explode: true + style: form + - in: query + name: vlan_group_id__n + schema: + type: array + items: + type: integer + description: VLAN Group (ID) + explode: true + style: form + - in: query + name: vlan_id + schema: + type: array + items: + type: integer + nullable: true + description: VLAN (ID) + explode: true + style: form + - in: query + name: vlan_id__n + schema: + type: array + items: + type: integer + nullable: true + description: VLAN (ID) + explode: true + style: form + - in: query + name: vlan_vid + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__empty + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__gt + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__gte + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__lt + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__lte + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__n + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vrf + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf__n + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf_id + schema: + type: array + items: + type: integer + nullable: true + description: VRF + explode: true + style: form + - in: query + name: vrf_id__n + schema: + type: array + items: + type: integer + nullable: true + description: VRF + explode: true + style: form + - in: query + name: within + schema: + type: string + description: Within prefix + - in: query + name: within_include + schema: + type: string + description: Within and including prefix + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPrefixList' + description: '' + post: + operationId: ipam_prefixes_create + description: Post a list of prefix objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePrefixRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePrefixRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritablePrefixRequest' + - type: array + items: + $ref: '#/components/schemas/WritablePrefixRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Prefix' + description: '' + put: + operationId: ipam_prefixes_bulk_update + description: Put a list of prefix objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Prefix' + description: '' + patch: + operationId: ipam_prefixes_bulk_partial_update + description: Patch a list of prefix objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Prefix' + description: '' + delete: + operationId: ipam_prefixes_bulk_destroy + description: Delete a list of prefix objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/prefixes/{id}/: + get: + operationId: ipam_prefixes_retrieve + description: Get a prefix object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this prefix. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Prefix' + description: '' + put: + operationId: ipam_prefixes_update + description: Put a prefix object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this prefix. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritablePrefixRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritablePrefixRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Prefix' + description: '' + patch: + operationId: ipam_prefixes_partial_update + description: Patch a prefix object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this prefix. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritablePrefixRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritablePrefixRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Prefix' + description: '' + delete: + operationId: ipam_prefixes_destroy + description: Delete a prefix object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this prefix. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/prefixes/{id}/available-ips/: + get: + operationId: ipam_prefixes_available_ips_list + description: Get a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableIP' + description: '' + post: + operationId: ipam_prefixes_available_ips_create + description: Post a IP address object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableIPRequestRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableIPRequestRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPAddress' + description: '' + /api/ipam/prefixes/{id}/available-prefixes/: + get: + operationId: ipam_prefixes_available_prefixes_list + description: Get a prefix object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailablePrefix' + description: '' + post: + operationId: ipam_prefixes_available_prefixes_create + description: Post a prefix object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixLengthRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/PrefixLengthRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Prefix' + description: '' + /api/ipam/rirs/: + get: + operationId: ipam_rirs_list + description: Get a list of RIR objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: is_private + schema: + type: boolean + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRIRList' + description: '' + post: + operationId: ipam_rirs_create + description: Post a list of RIR objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/RIRRequest' + - type: array + items: + $ref: '#/components/schemas/RIRRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/RIRRequest' + - type: array + items: + $ref: '#/components/schemas/RIRRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RIR' + description: '' + put: + operationId: ipam_rirs_bulk_update + description: Put a list of RIR objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RIRRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RIRRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RIR' + description: '' + patch: + operationId: ipam_rirs_bulk_partial_update + description: Patch a list of RIR objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RIRRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RIRRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RIR' + description: '' + delete: + operationId: ipam_rirs_bulk_destroy + description: Delete a list of RIR objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RIRRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RIRRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/rirs/{id}/: + get: + operationId: ipam_rirs_retrieve + description: Get a RIR object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this RIR. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RIR' + description: '' + put: + operationId: ipam_rirs_update + description: Put a RIR object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this RIR. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RIRRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/RIRRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RIR' + description: '' + patch: + operationId: ipam_rirs_partial_update + description: Patch a RIR object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this RIR. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedRIRRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedRIRRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RIR' + description: '' + delete: + operationId: ipam_rirs_destroy + description: Delete a RIR object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this RIR. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/roles/: + get: + operationId: ipam_roles_list + description: Get a list of role objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: weight + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__empty + schema: + type: boolean + - in: query + name: weight__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: weight__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRoleList' + description: '' + post: + operationId: ipam_roles_create + description: Post a list of role objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/RoleRequest' + - type: array + items: + $ref: '#/components/schemas/RoleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/RoleRequest' + - type: array + items: + $ref: '#/components/schemas/RoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: '' + put: + operationId: ipam_roles_bulk_update + description: Put a list of role objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Role' + description: '' + patch: + operationId: ipam_roles_bulk_partial_update + description: Patch a list of role objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Role' + description: '' + delete: + operationId: ipam_roles_bulk_destroy + description: Delete a list of role objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/roles/{id}/: + get: + operationId: ipam_roles_retrieve + description: Get a role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this role. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: '' + put: + operationId: ipam_roles_update + description: Put a role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this role. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/RoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: '' + patch: + operationId: ipam_roles_partial_update + description: Patch a role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this role. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedRoleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: '' + delete: + operationId: ipam_roles_destroy + description: Delete a role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this role. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/route-targets/: + get: + operationId: ipam_route_targets_list + description: Get a list of route target objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: exporting_l2vpn + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: Exporting L2VPN (identifier) + explode: true + style: form + - in: query + name: exporting_l2vpn__n + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: Exporting L2VPN (identifier) + explode: true + style: form + - in: query + name: exporting_l2vpn_id + schema: + type: array + items: + type: integer + description: Exporting L2VPN + explode: true + style: form + - in: query + name: exporting_l2vpn_id__n + schema: + type: array + items: + type: integer + description: Exporting L2VPN + explode: true + style: form + - in: query + name: exporting_vrf + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: Export VRF (RD) + explode: true + style: form + - in: query + name: exporting_vrf__n + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: Export VRF (RD) + explode: true + style: form + - in: query + name: exporting_vrf_id + schema: + type: array + items: + type: integer + description: Exporting VRF + explode: true + style: form + - in: query + name: exporting_vrf_id__n + schema: + type: array + items: + type: integer + description: Exporting VRF + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: importing_l2vpn + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: Importing L2VPN (identifier) + explode: true + style: form + - in: query + name: importing_l2vpn__n + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: Importing L2VPN (identifier) + explode: true + style: form + - in: query + name: importing_l2vpn_id + schema: + type: array + items: + type: integer + description: Importing L2VPN + explode: true + style: form + - in: query + name: importing_l2vpn_id__n + schema: + type: array + items: + type: integer + description: Importing L2VPN + explode: true + style: form + - in: query + name: importing_vrf + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: Import VRF (RD) + explode: true + style: form + - in: query + name: importing_vrf__n + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: Import VRF (RD) + explode: true + style: form + - in: query + name: importing_vrf_id + schema: + type: array + items: + type: integer + description: Importing VRF + explode: true + style: form + - in: query + name: importing_vrf_id__n + schema: + type: array + items: + type: integer + description: Importing VRF + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRouteTargetList' + description: '' + post: + operationId: ipam_route_targets_create + description: Post a list of route target objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/RouteTargetRequest' + - type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/RouteTargetRequest' + - type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/RouteTarget' + description: '' + put: + operationId: ipam_route_targets_bulk_update + description: Put a list of route target objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTarget' + description: '' + patch: + operationId: ipam_route_targets_bulk_partial_update + description: Patch a list of route target objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTarget' + description: '' + delete: + operationId: ipam_route_targets_bulk_destroy + description: Delete a list of route target objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/RouteTargetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/route-targets/{id}/: + get: + operationId: ipam_route_targets_retrieve + description: Get a route target object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this route target. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RouteTarget' + description: '' + put: + operationId: ipam_route_targets_update + description: Put a route target object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this route target. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RouteTargetRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/RouteTargetRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RouteTarget' + description: '' + patch: + operationId: ipam_route_targets_partial_update + description: Patch a route target object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this route target. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedRouteTargetRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedRouteTargetRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RouteTarget' + description: '' + delete: + operationId: ipam_route_targets_destroy + description: Delete a route target object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this route target. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/service-templates/: + get: + operationId: ipam_service_templates_list + description: Get a list of application service template objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: port + schema: + type: number + - in: query + name: port__empty + schema: + type: number + - in: query + name: port__gt + schema: + type: number + - in: query + name: port__gte + schema: + type: number + - in: query + name: port__lt + schema: + type: number + - in: query + name: port__lte + schema: + type: number + - in: query + name: port__n + schema: + type: number + - in: query + name: protocol + schema: + type: string + x-spec-enum-id: e4b15bec749a2a32 + enum: + - 'null' + - sctp + - tcp + - udp + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + - in: query + name: protocol__empty + schema: + type: boolean + - in: query + name: protocol__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__n + schema: + type: string + x-spec-enum-id: e4b15bec749a2a32 + enum: + - 'null' + - sctp + - tcp + - udp + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + - in: query + name: protocol__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedServiceTemplateList' + description: '' + post: + operationId: ipam_service_templates_create + description: Post a list of application service template objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableServiceTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableServiceTemplateRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableServiceTemplateRequest' + - type: array + items: + $ref: '#/components/schemas/WritableServiceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceTemplate' + description: '' + put: + operationId: ipam_service_templates_bulk_update + description: Put a list of application service template objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplate' + description: '' + patch: + operationId: ipam_service_templates_bulk_partial_update + description: Patch a list of application service template objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplate' + description: '' + delete: + operationId: ipam_service_templates_bulk_destroy + description: Delete a list of application service template objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplateRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/service-templates/{id}/: + get: + operationId: ipam_service_templates_retrieve + description: Get a application service template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service template. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceTemplate' + description: '' + put: + operationId: ipam_service_templates_update + description: Put a application service template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service template. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableServiceTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableServiceTemplateRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceTemplate' + description: '' + patch: + operationId: ipam_service_templates_partial_update + description: Patch a application service template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service template. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableServiceTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableServiceTemplateRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceTemplate' + description: '' + delete: + operationId: ipam_service_templates_destroy + description: Delete a application service template object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service template. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/services/: + get: + operationId: ipam_services_list + description: Get a list of application service objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: fhrpgroup + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: fhrpgroup_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: ip_address + schema: + type: array + items: + type: string + description: IP address + explode: true + style: form + - in: query + name: ip_address__n + schema: + type: array + items: + type: string + description: IP address + explode: true + style: form + - in: query + name: ip_address_id + schema: + type: array + items: + type: integer + description: IP address (ID) + explode: true + style: form + - in: query + name: ip_address_id__n + schema: + type: array + items: + type: integer + description: IP address (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: parent_object_id__empty + schema: + type: boolean + - in: query + name: parent_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: parent_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: parent_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: parent_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: parent_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: parent_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: parent_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: port + schema: + type: number + - in: query + name: port__empty + schema: + type: number + - in: query + name: port__gt + schema: + type: number + - in: query + name: port__gte + schema: + type: number + - in: query + name: port__lt + schema: + type: number + - in: query + name: port__lte + schema: + type: number + - in: query + name: port__n + schema: + type: number + - in: query + name: protocol + schema: + type: string + x-spec-enum-id: e4b15bec749a2a32 + enum: + - 'null' + - sctp + - tcp + - udp + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + - in: query + name: protocol__empty + schema: + type: boolean + - in: query + name: protocol__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__n + schema: + type: string + x-spec-enum-id: e4b15bec749a2a32 + enum: + - 'null' + - sctp + - tcp + - udp + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + - in: query + name: protocol__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: protocol__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: virtual_machine_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedServiceList' + description: '' + post: + operationId: ipam_services_create + description: Post a list of application service objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableServiceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableServiceRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableServiceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableServiceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Service' + description: '' + put: + operationId: ipam_services_bulk_update + description: Put a list of application service objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + description: '' + patch: + operationId: ipam_services_bulk_partial_update + description: Patch a list of application service objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + description: '' + delete: + operationId: ipam_services_bulk_destroy + description: Delete a list of application service objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/services/{id}/: + get: + operationId: ipam_services_retrieve + description: Get a application service object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Service' + description: '' + put: + operationId: ipam_services_update + description: Put a application service object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableServiceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableServiceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Service' + description: '' + patch: + operationId: ipam_services_partial_update + description: Patch a application service object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableServiceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableServiceRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Service' + description: '' + delete: + operationId: ipam_services_destroy + description: Delete a application service object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this application service. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlan-groups/: + get: + operationId: ipam_vlan_groups_list + description: Get a list of VLAN group objects. + parameters: + - in: query + name: cluster + schema: + type: integer + - in: query + name: cluster_group + schema: + type: integer + - in: query + name: contains_vid + schema: + type: number + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rack + schema: + type: integer + - in: query + name: rack_group + schema: + type: number + - in: query + name: region + schema: + type: integer + - in: query + name: scope_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__empty + schema: + type: boolean + - in: query + name: scope_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: scope_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: integer + - in: query + name: site_group + schema: + type: integer + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: total_vlan_ids + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: total_vlan_ids__empty + schema: + type: boolean + - in: query + name: total_vlan_ids__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: total_vlan_ids__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: total_vlan_ids__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: total_vlan_ids__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: total_vlan_ids__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVLANGroupList' + description: '' + post: + operationId: ipam_vlan_groups_create + description: Post a list of VLAN group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/VLANGroupRequest' + - type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/VLANGroupRequest' + - type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANGroup' + description: '' + put: + operationId: ipam_vlan_groups_bulk_update + description: Put a list of VLAN group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroup' + description: '' + patch: + operationId: ipam_vlan_groups_bulk_partial_update + description: Patch a list of VLAN group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroup' + description: '' + delete: + operationId: ipam_vlan_groups_bulk_destroy + description: Delete a list of VLAN group objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlan-groups/{id}/: + get: + operationId: ipam_vlan_groups_retrieve + description: Get a VLAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN group. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANGroup' + description: '' + put: + operationId: ipam_vlan_groups_update + description: Put a VLAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN group. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VLANGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/VLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANGroup' + description: '' + patch: + operationId: ipam_vlan_groups_partial_update + description: Patch a VLAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN group. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVLANGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedVLANGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANGroup' + description: '' + delete: + operationId: ipam_vlan_groups_destroy + description: Delete a VLAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN group. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlan-groups/{id}/available-vlans/: + get: + operationId: ipam_vlan_groups_available_vlans_list + description: Get a VLAN object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableVLAN' + description: '' + post: + operationId: ipam_vlan_groups_available_vlans_create + description: Post a VLAN object. + parameters: + - in: path + name: id + schema: + type: integer + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CreateAvailableVLANRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/CreateAvailableVLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLAN' + description: '' + /api/ipam/vlan-translation-policies/: + get: + operationId: ipam_vlan_translation_policies_list + description: Get a list of VLAN translation policy objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVLANTranslationPolicyList' + description: '' + post: + operationId: ipam_vlan_translation_policies_create + description: Post a list of VLAN translation policy objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/VLANTranslationPolicyRequest' + - type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/VLANTranslationPolicyRequest' + - type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationPolicy' + description: '' + put: + operationId: ipam_vlan_translation_policies_bulk_update + description: Put a list of VLAN translation policy objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicy' + description: '' + patch: + operationId: ipam_vlan_translation_policies_bulk_partial_update + description: Patch a list of VLAN translation policy objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicy' + description: '' + delete: + operationId: ipam_vlan_translation_policies_bulk_destroy + description: Delete a list of VLAN translation policy objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlan-translation-policies/{id}/: + get: + operationId: ipam_vlan_translation_policies_retrieve + description: Get a VLAN translation policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation policy. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationPolicy' + description: '' + put: + operationId: ipam_vlan_translation_policies_update + description: Put a VLAN translation policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation policy. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/VLANTranslationPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationPolicy' + description: '' + patch: + operationId: ipam_vlan_translation_policies_partial_update + description: Patch a VLAN translation policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation policy. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVLANTranslationPolicyRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedVLANTranslationPolicyRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationPolicy' + description: '' + delete: + operationId: ipam_vlan_translation_policies_destroy + description: Delete a VLAN translation policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation policy. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlan-translation-rules/: + get: + operationId: ipam_vlan_translation_rules_list + description: Get a list of VLAN translation rule objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: local_vid + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: local_vid__empty + schema: + type: boolean + - in: query + name: local_vid__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: local_vid__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: local_vid__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: local_vid__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: local_vid__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: policy + schema: + type: array + items: + type: string + description: VLAN Translation Policy (name) + explode: true + style: form + - in: query + name: policy__n + schema: + type: array + items: + type: string + description: VLAN Translation Policy (name) + explode: true + style: form + - in: query + name: policy_id + schema: + type: array + items: + type: integer + description: VLAN Translation Policy (ID) + explode: true + style: form + - in: query + name: policy_id__n + schema: + type: array + items: + type: integer + description: VLAN Translation Policy (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: remote_vid + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: remote_vid__empty + schema: + type: boolean + - in: query + name: remote_vid__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: remote_vid__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: remote_vid__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: remote_vid__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: remote_vid__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVLANTranslationRuleList' + description: '' + post: + operationId: ipam_vlan_translation_rules_create + description: Post a list of VLAN translation rule objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/VLANTranslationRuleRequest' + - type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/VLANTranslationRuleRequest' + - type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationRule' + description: '' + put: + operationId: ipam_vlan_translation_rules_bulk_update + description: Put a list of VLAN translation rule objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRule' + description: '' + patch: + operationId: ipam_vlan_translation_rules_bulk_partial_update + description: Patch a list of VLAN translation rule objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRule' + description: '' + delete: + operationId: ipam_vlan_translation_rules_bulk_destroy + description: Delete a list of VLAN translation rule objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlan-translation-rules/{id}/: + get: + operationId: ipam_vlan_translation_rules_retrieve + description: Get a VLAN translation rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation rule. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationRule' + description: '' + put: + operationId: ipam_vlan_translation_rules_update + description: Put a VLAN translation rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation rule. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/VLANTranslationRuleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationRule' + description: '' + patch: + operationId: ipam_vlan_translation_rules_partial_update + description: Patch a VLAN translation rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation rule. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVLANTranslationRuleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedVLANTranslationRuleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLANTranslationRule' + description: '' + delete: + operationId: ipam_vlan_translation_rules_destroy + description: Delete a VLAN translation rule object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN translation rule. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlans/: + get: + operationId: ipam_vlans_list + description: Get a list of VLAN objects. + parameters: + - in: query + name: available_at_site + schema: + type: string + - in: query + name: available_on_device + schema: + type: string + - in: query + name: available_on_virtualmachine + schema: + type: string + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + description: Group + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Group + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + nullable: true + description: Group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id + schema: + type: integer + - in: query + name: l2vpn + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: L2VPN + explode: true + style: form + - in: query + name: l2vpn__n + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: L2VPN + explode: true + style: form + - in: query + name: l2vpn_id + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: l2vpn_id__n + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: qinq_role + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__empty + schema: + type: boolean + - in: query + name: qinq_role__ic + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__ie + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__iew + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__isw + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__n + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__nic + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__nie + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__niew + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_role__regex + schema: + type: array + items: + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + explode: true + style: form + - in: query + name: qinq_svlan_id + schema: + type: array + items: + type: integer + nullable: true + description: Q-in-Q SVLAN (ID) + explode: true + style: form + - in: query + name: qinq_svlan_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Q-in-Q SVLAN (ID) + explode: true + style: form + - in: query + name: qinq_svlan_vid + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: qinq_svlan_vid__empty + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: qinq_svlan_vid__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: qinq_svlan_vid__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: qinq_svlan_vid__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: qinq_svlan_vid__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: qinq_svlan_vid__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Role (ID) + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + nullable: true + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: ca933c38b935e547 + description: Operational status of this VLAN + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vid + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vid__empty + schema: + type: boolean + - in: query + name: vid__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vid__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vid__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vid__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vid__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: vminterface_id + schema: + type: integer + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVLANList' + description: '' + post: + operationId: ipam_vlans_create + description: Post a list of VLAN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVLANRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVLANRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVLANRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VLAN' + description: '' + put: + operationId: ipam_vlans_bulk_update + description: Put a list of VLAN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLAN' + description: '' + patch: + operationId: ipam_vlans_bulk_partial_update + description: Patch a list of VLAN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLAN' + description: '' + delete: + operationId: ipam_vlans_bulk_destroy + description: Delete a list of VLAN objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VLANRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vlans/{id}/: + get: + operationId: ipam_vlans_retrieve + description: Get a VLAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLAN' + description: '' + put: + operationId: ipam_vlans_update + description: Put a VLAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVLANRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLAN' + description: '' + patch: + operationId: ipam_vlans_partial_update + description: Patch a VLAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableVLANRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableVLANRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VLAN' + description: '' + delete: + operationId: ipam_vlans_destroy + description: Delete a VLAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VLAN. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vrfs/: + get: + operationId: ipam_vrfs_list + description: Get a list of VRF objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enforce_unique + schema: + type: boolean + - in: query + name: export_target + schema: + type: array + items: + type: string + description: Export target (name) + explode: true + style: form + - in: query + name: export_target__n + schema: + type: array + items: + type: string + description: Export target (name) + explode: true + style: form + - in: query + name: export_target_id + schema: + type: array + items: + type: integer + description: Export target + explode: true + style: form + - in: query + name: export_target_id__n + schema: + type: array + items: + type: integer + description: Export target + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: import_target + schema: + type: array + items: + type: string + description: Import target (name) + explode: true + style: form + - in: query + name: import_target__n + schema: + type: array + items: + type: string + description: Import target (name) + explode: true + style: form + - in: query + name: import_target_id + schema: + type: array + items: + type: integer + description: Import target + explode: true + style: form + - in: query + name: import_target_id__n + schema: + type: array + items: + type: integer + description: Import target + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: rd + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__empty + schema: + type: boolean + - in: query + name: rd__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: rd__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVRFList' + description: '' + post: + operationId: ipam_vrfs_create + description: Post a list of VRF objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/VRFRequest' + - type: array + items: + $ref: '#/components/schemas/VRFRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/VRFRequest' + - type: array + items: + $ref: '#/components/schemas/VRFRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VRF' + description: '' + put: + operationId: ipam_vrfs_bulk_update + description: Put a list of VRF objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VRFRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VRFRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VRF' + description: '' + patch: + operationId: ipam_vrfs_bulk_partial_update + description: Patch a list of VRF objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VRFRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VRFRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VRF' + description: '' + delete: + operationId: ipam_vrfs_bulk_destroy + description: Delete a list of VRF objects. + tags: + - ipam + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VRFRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VRFRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/ipam/vrfs/{id}/: + get: + operationId: ipam_vrfs_retrieve + description: Get a VRF object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VRF. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VRF' + description: '' + put: + operationId: ipam_vrfs_update + description: Put a VRF object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VRF. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VRFRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/VRFRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VRF' + description: '' + patch: + operationId: ipam_vrfs_partial_update + description: Patch a VRF object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VRF. + required: true + tags: + - ipam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVRFRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedVRFRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VRF' + description: '' + delete: + operationId: ipam_vrfs_destroy + description: Delete a VRF object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this VRF. + required: true + tags: + - ipam + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/schema/: + get: + operationId: schema_retrieve + description: |- + OpenApi3 schema for this API. Format can be selected via content negotiation. + + - YAML: application/vnd.oai.openapi + - JSON: application/vnd.oai.openapi+json + parameters: + - in: query + name: format + schema: + type: string + enum: + - json + - yaml + - in: query + name: lang + schema: + type: string + enum: + - cs + - da + - de + - en + - es + - fr + - it + - ja + - lv + - nl + - pl + - pt + - ru + - tr + - uk + - zh + tags: + - schema + security: + - cookieAuth: [] + - tokenAuth: [] + - {} + responses: + '200': + content: + application/vnd.oai.openapi: + schema: + type: object + additionalProperties: {} + application/yaml: + schema: + type: object + additionalProperties: {} + application/vnd.oai.openapi+json: + schema: + type: object + additionalProperties: {} + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/status/: + get: + operationId: status_retrieve + description: A lightweight read-only endpoint for conveying NetBox's current + operational status. + tags: + - status + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/tenancy/contact-assignments/: + get: + operationId: tenancy_contact_assignments_list + description: Get a list of contact assignment objects. + parameters: + - in: query + name: contact_id + schema: + type: array + items: + type: integer + description: Contact (ID) + explode: true + style: form + - in: query + name: contact_id__n + schema: + type: array + items: + type: integer + description: Contact (ID) + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__empty + schema: + type: boolean + - in: query + name: object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: integer + - in: query + name: object_type_id__n + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: priority + schema: + type: string + x-spec-enum-id: 0548fc537440bf9d + nullable: true + enum: + - inactive + - 'null' + - primary + - secondary + - tertiary + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + - in: query + name: priority__empty + schema: + type: boolean + - in: query + name: priority__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__n + schema: + type: string + x-spec-enum-id: 0548fc537440bf9d + nullable: true + enum: + - inactive + - 'null' + - primary + - secondary + - tertiary + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + - in: query + name: priority__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: priority__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: role + schema: + type: array + items: + type: string + description: Contact role (slug) + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + description: Contact role (slug) + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: integer + description: Contact role (ID) + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: integer + description: Contact role (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedContactAssignmentList' + description: '' + post: + operationId: tenancy_contact_assignments_create + description: Post a list of contact assignment objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableContactAssignmentRequest' + - type: array + items: + $ref: '#/components/schemas/WritableContactAssignmentRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableContactAssignmentRequest' + - type: array + items: + $ref: '#/components/schemas/WritableContactAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactAssignment' + description: '' + put: + operationId: tenancy_contact_assignments_bulk_update + description: Put a list of contact assignment objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignment' + description: '' + patch: + operationId: tenancy_contact_assignments_bulk_partial_update + description: Patch a list of contact assignment objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignment' + description: '' + delete: + operationId: tenancy_contact_assignments_bulk_destroy + description: Delete a list of contact assignment objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignmentRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/contact-assignments/{id}/: + get: + operationId: tenancy_contact_assignments_retrieve + description: Get a contact assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact assignment. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactAssignment' + description: '' + put: + operationId: tenancy_contact_assignments_update + description: Put a contact assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact assignment. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableContactAssignmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableContactAssignmentRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactAssignment' + description: '' + patch: + operationId: tenancy_contact_assignments_partial_update + description: Patch a contact assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact assignment. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableContactAssignmentRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableContactAssignmentRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactAssignment' + description: '' + delete: + operationId: tenancy_contact_assignments_destroy + description: Delete a contact assignment object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact assignment. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/contact-groups/: + get: + operationId: tenancy_contact_groups_list + description: Get a list of contact group objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_id + schema: + type: array + items: + type: integer + description: Contact (ID) + explode: true + style: form + - in: query + name: contact_id__n + schema: + type: array + items: + type: integer + description: Contact (ID) + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + description: Parent contact group (slug) + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + description: Parent contact group (slug) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent contact group (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent contact group (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedContactGroupList' + description: '' + post: + operationId: tenancy_contact_groups_create + description: Post a list of contact group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableContactGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableContactGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableContactGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableContactGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactGroup' + description: '' + put: + operationId: tenancy_contact_groups_bulk_update + description: Put a list of contact group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroup' + description: '' + patch: + operationId: tenancy_contact_groups_bulk_partial_update + description: Patch a list of contact group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroup' + description: '' + delete: + operationId: tenancy_contact_groups_bulk_destroy + description: Delete a list of contact group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/contact-groups/{id}/: + get: + operationId: tenancy_contact_groups_retrieve + description: Get a contact group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact group. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactGroup' + description: '' + put: + operationId: tenancy_contact_groups_update + description: Put a contact group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact group. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableContactGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableContactGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactGroup' + description: '' + patch: + operationId: tenancy_contact_groups_partial_update + description: Patch a contact group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact group. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableContactGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableContactGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactGroup' + description: '' + delete: + operationId: tenancy_contact_groups_destroy + description: Delete a contact group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact group. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/contact-roles/: + get: + operationId: tenancy_contact_roles_list + description: Get a list of contact role objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedContactRoleList' + description: '' + post: + operationId: tenancy_contact_roles_create + description: Post a list of contact role objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ContactRoleRequest' + - type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ContactRoleRequest' + - type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactRole' + description: '' + put: + operationId: tenancy_contact_roles_bulk_update + description: Put a list of contact role objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRole' + description: '' + patch: + operationId: tenancy_contact_roles_bulk_partial_update + description: Patch a list of contact role objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRole' + description: '' + delete: + operationId: tenancy_contact_roles_bulk_destroy + description: Delete a list of contact role objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/contact-roles/{id}/: + get: + operationId: tenancy_contact_roles_retrieve + description: Get a contact role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact role. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactRole' + description: '' + put: + operationId: tenancy_contact_roles_update + description: Put a contact role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact role. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ContactRoleRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactRole' + description: '' + patch: + operationId: tenancy_contact_roles_partial_update + description: Patch a contact role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact role. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedContactRoleRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedContactRoleRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ContactRole' + description: '' + delete: + operationId: tenancy_contact_roles_destroy + description: Delete a contact role object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact role. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/contacts/: + get: + operationId: tenancy_contacts_list + description: Get a list of contact objects. + parameters: + - in: query + name: address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__empty + schema: + type: boolean + - in: query + name: address__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: address__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__empty + schema: + type: boolean + - in: query + name: email__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: link + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__empty + schema: + type: boolean + - in: query + name: link__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: link__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: phone + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__empty + schema: + type: boolean + - in: query + name: phone__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: phone__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: title + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__empty + schema: + type: boolean + - in: query + name: title__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: title__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedContactList' + description: '' + post: + operationId: tenancy_contacts_create + description: Post a list of contact objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ContactRequest' + - type: array + items: + $ref: '#/components/schemas/ContactRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ContactRequest' + - type: array + items: + $ref: '#/components/schemas/ContactRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Contact' + description: '' + put: + operationId: tenancy_contacts_bulk_update + description: Put a list of contact objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Contact' + description: '' + patch: + operationId: tenancy_contacts_bulk_partial_update + description: Patch a list of contact objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Contact' + description: '' + delete: + operationId: tenancy_contacts_bulk_destroy + description: Delete a list of contact objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ContactRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/contacts/{id}/: + get: + operationId: tenancy_contacts_retrieve + description: Get a contact object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Contact' + description: '' + put: + operationId: tenancy_contacts_update + description: Put a contact object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ContactRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Contact' + description: '' + patch: + operationId: tenancy_contacts_partial_update + description: Patch a contact object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedContactRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedContactRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Contact' + description: '' + delete: + operationId: tenancy_contacts_destroy + description: Delete a contact object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this contact. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/tenant-groups/: + get: + operationId: tenancy_tenant_groups_list + description: Get a list of tenant group objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + description: Parent tenant group (slug) + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + description: Parent tenant group (slug) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent tenant group (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent tenant group (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTenantGroupList' + description: '' + post: + operationId: tenancy_tenant_groups_create + description: Post a list of tenant group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableTenantGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableTenantGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableTenantGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableTenantGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantGroup' + description: '' + put: + operationId: tenancy_tenant_groups_bulk_update + description: Put a list of tenant group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroup' + description: '' + patch: + operationId: tenancy_tenant_groups_bulk_partial_update + description: Patch a list of tenant group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroup' + description: '' + delete: + operationId: tenancy_tenant_groups_bulk_destroy + description: Delete a list of tenant group objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TenantGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/tenant-groups/{id}/: + get: + operationId: tenancy_tenant_groups_retrieve + description: Get a tenant group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant group. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantGroup' + description: '' + put: + operationId: tenancy_tenant_groups_update + description: Put a tenant group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant group. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableTenantGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableTenantGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantGroup' + description: '' + patch: + operationId: tenancy_tenant_groups_partial_update + description: Patch a tenant group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant group. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableTenantGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableTenantGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantGroup' + description: '' + delete: + operationId: tenancy_tenant_groups_destroy + description: Delete a tenant group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant group. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/tenants/: + get: + operationId: tenancy_tenants_list + description: Get a list of tenant objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTenantList' + description: '' + post: + operationId: tenancy_tenants_create + description: Post a list of tenant objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TenantRequest' + - type: array + items: + $ref: '#/components/schemas/TenantRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/TenantRequest' + - type: array + items: + $ref: '#/components/schemas/TenantRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: '' + put: + operationId: tenancy_tenants_bulk_update + description: Put a list of tenant objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TenantRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tenant' + description: '' + patch: + operationId: tenancy_tenants_bulk_partial_update + description: Patch a list of tenant objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TenantRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tenant' + description: '' + delete: + operationId: tenancy_tenants_bulk_destroy + description: Delete a list of tenant objects. + tags: + - tenancy + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TenantRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TenantRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/tenancy/tenants/{id}/: + get: + operationId: tenancy_tenants_retrieve + description: Get a tenant object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: '' + put: + operationId: tenancy_tenants_update + description: Put a tenant object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TenantRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: '' + patch: + operationId: tenancy_tenants_partial_update + description: Patch a tenant object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant. + required: true + tags: + - tenancy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedTenantRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedTenantRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + description: '' + delete: + operationId: tenancy_tenants_destroy + description: Delete a tenant object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tenant. + required: true + tags: + - tenancy + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/config/: + get: + operationId: users_config_retrieve + description: An API endpoint via which a user can update his or her own UserConfig + data (but no one else's). + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/users/groups/: + get: + operationId: users_groups_list + description: Get a list of group objects. + parameters: + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: notification_group_id + schema: + type: array + items: + type: integer + description: Notification group (ID) + explode: true + style: form + - in: query + name: notification_group_id__n + schema: + type: array + items: + type: integer + description: Notification group (ID) + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + description: Owner (ID) + explode: true + style: form + - in: query + name: permission_id + schema: + type: array + items: + type: integer + description: Permission (ID) + explode: true + style: form + - in: query + name: permission_id__n + schema: + type: array + items: + type: integer + description: Permission (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: user_id + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedGroupList' + description: '' + post: + operationId: users_groups_create + description: Post a list of group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/GroupRequest' + - type: array + items: + $ref: '#/components/schemas/GroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/GroupRequest' + - type: array + items: + $ref: '#/components/schemas/GroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + description: '' + put: + operationId: users_groups_bulk_update + description: Put a list of group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/GroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Group' + description: '' + patch: + operationId: users_groups_bulk_partial_update + description: Patch a list of group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/GroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Group' + description: '' + delete: + operationId: users_groups_bulk_destroy + description: Delete a list of group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/GroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/groups/{id}/: + get: + operationId: users_groups_retrieve + description: Get a group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this group. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + description: '' + put: + operationId: users_groups_update + description: Put a group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this group. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/GroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + description: '' + patch: + operationId: users_groups_partial_update + description: Patch a group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this group. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Group' + description: '' + delete: + operationId: users_groups_destroy + description: Delete a group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this group. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/owner-groups/: + get: + operationId: users_owner_groups_list + description: Get a list of owner group objects. + parameters: + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedOwnerGroupList' + description: '' + post: + operationId: users_owner_groups_create + description: Post a list of owner group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/OwnerGroupRequest' + - type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/OwnerGroupRequest' + - type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OwnerGroup' + description: '' + put: + operationId: users_owner_groups_bulk_update + description: Put a list of owner group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroup' + description: '' + patch: + operationId: users_owner_groups_bulk_partial_update + description: Patch a list of owner group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroup' + description: '' + delete: + operationId: users_owner_groups_bulk_destroy + description: Delete a list of owner group objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/owner-groups/{id}/: + get: + operationId: users_owner_groups_retrieve + description: Get a owner group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner group. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OwnerGroup' + description: '' + put: + operationId: users_owner_groups_update + description: Put a owner group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner group. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OwnerGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/OwnerGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OwnerGroup' + description: '' + patch: + operationId: users_owner_groups_partial_update + description: Patch a owner group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner group. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedOwnerGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedOwnerGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OwnerGroup' + description: '' + delete: + operationId: users_owner_groups_destroy + description: Delete a owner group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner group. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/owners/: + get: + operationId: users_owners_list + description: Get a list of owner objects. + parameters: + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + description: Group (name) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Group (name) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + nullable: true + description: Group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: user + schema: + type: array + items: + type: string + description: User (username) + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User (username) + explode: true + style: form + - in: query + name: user_group + schema: + type: array + items: + type: string + description: User group (name) + explode: true + style: form + - in: query + name: user_group__n + schema: + type: array + items: + type: string + description: User group (name) + explode: true + style: form + - in: query + name: user_group_id + schema: + type: array + items: + type: integer + description: User group (ID) + explode: true + style: form + - in: query + name: user_group_id__n + schema: + type: array + items: + type: integer + description: User group (ID) + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + description: User (ID) + explode: true + style: form + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedOwnerList' + description: '' + post: + operationId: users_owners_create + description: Post a list of owner objects. + tags: + - users + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/OwnerRequest' + - type: array + items: + $ref: '#/components/schemas/OwnerRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/OwnerRequest' + - type: array + items: + $ref: '#/components/schemas/OwnerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Owner' + description: '' + put: + operationId: users_owners_bulk_update + description: Put a list of owner objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Owner' + description: '' + patch: + operationId: users_owners_bulk_partial_update + description: Patch a list of owner objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Owner' + description: '' + delete: + operationId: users_owners_bulk_destroy + description: Delete a list of owner objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/OwnerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/owners/{id}/: + get: + operationId: users_owners_retrieve + description: Get a owner object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Owner' + description: '' + put: + operationId: users_owners_update + description: Put a owner object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OwnerRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/OwnerRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Owner' + description: '' + patch: + operationId: users_owners_partial_update + description: Patch a owner object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedOwnerRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedOwnerRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Owner' + description: '' + delete: + operationId: users_owners_destroy + description: Delete a owner object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this owner. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/permissions/: + get: + operationId: users_permissions_list + description: Get a list of permission objects. + parameters: + - in: query + name: can_add + schema: + type: boolean + - in: query + name: can_change + schema: + type: boolean + - in: query + name: can_delete + schema: + type: boolean + - in: query + name: can_view + schema: + type: boolean + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: group + schema: + type: array + items: + type: string + description: Group (name) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Group (name) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + description: Group + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + description: Group + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_types + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: object_types__n + schema: + type: array + items: + type: integer + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: user + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + description: User + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + description: User + explode: true + style: form + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedObjectPermissionList' + description: '' + post: + operationId: users_permissions_create + description: Post a list of permission objects. + tags: + - users + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ObjectPermissionRequest' + - type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ObjectPermissionRequest' + - type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectPermission' + description: '' + put: + operationId: users_permissions_bulk_update + description: Put a list of permission objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermission' + description: '' + patch: + operationId: users_permissions_bulk_partial_update + description: Patch a list of permission objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermission' + description: '' + delete: + operationId: users_permissions_bulk_destroy + description: Delete a list of permission objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectPermissionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/permissions/{id}/: + get: + operationId: users_permissions_retrieve + description: Get a permission object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this permission. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectPermission' + description: '' + put: + operationId: users_permissions_update + description: Put a permission object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this permission. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectPermissionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ObjectPermissionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectPermission' + description: '' + patch: + operationId: users_permissions_partial_update + description: Patch a permission object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this permission. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedObjectPermissionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedObjectPermissionRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectPermission' + description: '' + delete: + operationId: users_permissions_destroy + description: Delete a permission object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this permission. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/tokens/: + get: + operationId: users_tokens_list + description: Get a list of token objects. + parameters: + - in: query + name: created + schema: + type: string + format: date-time + - in: query + name: created__gte + schema: + type: string + format: date-time + - in: query + name: created__lte + schema: + type: string + format: date-time + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: expires + schema: + type: string + format: date-time + - in: query + name: expires__gte + schema: + type: string + format: date-time + - in: query + name: expires__lte + schema: + type: string + format: date-time + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: key + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__empty + schema: + type: boolean + - in: query + name: key__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: key__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_used + schema: + type: string + format: date-time + - in: query + name: last_used__gte + schema: + type: string + format: date-time + - in: query + name: last_used__lte + schema: + type: string + format: date-time + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: pepper_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: pepper_id__empty + schema: + type: boolean + - in: query + name: pepper_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: pepper_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: pepper_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: pepper_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: pepper_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: user + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user__n + schema: + type: array + items: + type: string + description: User (name) + explode: true + style: form + - in: query + name: user_id + schema: + type: array + items: + type: integer + description: User + explode: true + style: form + - in: query + name: user_id__n + schema: + type: array + items: + type: integer + description: User + explode: true + style: form + - in: query + name: version + schema: + type: integer + x-spec-enum-id: b5df70f0bffd12cb + enum: + - 1 + - 2 + - 'null' + description: |- + * `1` - v1 + * `2` - v2 + - in: query + name: version__ic + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__ie + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__iew + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__iregex + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__isw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__n + schema: + type: integer + x-spec-enum-id: b5df70f0bffd12cb + enum: + - 1 + - 2 + - 'null' + description: |- + * `1` - v1 + * `2` - v2 + - in: query + name: version__nic + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__nie + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__niew + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__nisw + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: version__regex + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: write_enabled + schema: + type: boolean + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTokenList' + description: '' + post: + operationId: users_tokens_create + description: Post a list of token objects. + tags: + - users + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TokenRequest' + - type: array + items: + $ref: '#/components/schemas/TokenRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/TokenRequest' + - type: array + items: + $ref: '#/components/schemas/TokenRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Token' + description: '' + put: + operationId: users_tokens_bulk_update + description: Put a list of token objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TokenRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TokenRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Token' + description: '' + patch: + operationId: users_tokens_bulk_partial_update + description: Patch a list of token objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TokenRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TokenRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Token' + description: '' + delete: + operationId: users_tokens_bulk_destroy + description: Delete a list of token objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TokenRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TokenRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/tokens/{id}/: + get: + operationId: users_tokens_retrieve + description: Get a token object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this token. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Token' + description: '' + put: + operationId: users_tokens_update + description: Put a token object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this token. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TokenRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TokenRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Token' + description: '' + patch: + operationId: users_tokens_partial_update + description: Patch a token object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this token. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedTokenRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedTokenRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Token' + description: '' + delete: + operationId: users_tokens_destroy + description: Delete a token object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this token. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/tokens/provision/: + post: + operationId: users_tokens_provision_create + description: Non-authenticated REST API endpoint via which a user may create + a Token. + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TokenProvisionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TokenProvisionRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TokenProvision' + description: '' + '401': + content: + application/json: + schema: + type: object + additionalProperties: {} + description: '' + /api/users/users/: + get: + operationId: users_users_list + description: Get a list of user objects. + parameters: + - in: query + name: date_joined + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: date_joined__empty + schema: + type: boolean + - in: query + name: date_joined__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: date_joined__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: date_joined__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: date_joined__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: date_joined__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: email + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__empty + schema: + type: boolean + - in: query + name: email__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: email__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__empty + schema: + type: boolean + - in: query + name: first_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: first_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + description: Group (name) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Group (name) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + description: Group + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + description: Group + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: is_active + schema: + type: boolean + - in: query + name: is_superuser + schema: + type: boolean + - in: query + name: last_login + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_login__empty + schema: + type: boolean + - in: query + name: last_login__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_login__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_login__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_login__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_login__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__empty + schema: + type: boolean + - in: query + name: last_name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: last_name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: notification_group_id + schema: + type: array + items: + type: integer + description: Notification group (ID) + explode: true + style: form + - in: query + name: notification_group_id__n + schema: + type: array + items: + type: integer + description: Notification group (ID) + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + description: Owner (ID) + explode: true + style: form + - in: query + name: permission_id + schema: + type: array + items: + type: integer + description: Permission (ID) + explode: true + style: form + - in: query + name: permission_id__n + schema: + type: array + items: + type: integer + description: Permission (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: username + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__empty + schema: + type: boolean + - in: query + name: username__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: username__regex + schema: + type: array + items: + type: string + explode: true + style: form + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedUserList' + description: '' + post: + operationId: users_users_create + description: Post a list of user objects. + tags: + - users + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/UserRequest' + - type: array + items: + $ref: '#/components/schemas/UserRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/UserRequest' + - type: array + items: + $ref: '#/components/schemas/UserRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: '' + put: + operationId: users_users_bulk_update + description: Put a list of user objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UserRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/UserRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + description: '' + patch: + operationId: users_users_bulk_partial_update + description: Patch a list of user objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UserRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/UserRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + description: '' + delete: + operationId: users_users_bulk_destroy + description: Delete a list of user objects. + tags: + - users + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UserRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/UserRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/users/users/{id}/: + get: + operationId: users_users_retrieve + description: Get a user object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: '' + put: + operationId: users_users_update + description: Put a user object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/UserRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: '' + patch: + operationId: users_users_partial_update + description: Patch a user object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true + tags: + - users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedUserRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedUserRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: '' + delete: + operationId: users_users_destroy + description: Delete a user object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true + tags: + - users + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/cluster-groups/: + get: + operationId: virtualization_cluster_groups_list + description: Get a list of cluster group objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedClusterGroupList' + description: '' + post: + operationId: virtualization_cluster_groups_create + description: Post a list of cluster group objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ClusterGroupRequest' + - type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ClusterGroupRequest' + - type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterGroup' + description: '' + put: + operationId: virtualization_cluster_groups_bulk_update + description: Put a list of cluster group objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroup' + description: '' + patch: + operationId: virtualization_cluster_groups_bulk_partial_update + description: Patch a list of cluster group objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroup' + description: '' + delete: + operationId: virtualization_cluster_groups_bulk_destroy + description: Delete a list of cluster group objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/cluster-groups/{id}/: + get: + operationId: virtualization_cluster_groups_retrieve + description: Get a cluster group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster group. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterGroup' + description: '' + put: + operationId: virtualization_cluster_groups_update + description: Put a cluster group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster group. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ClusterGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterGroup' + description: '' + patch: + operationId: virtualization_cluster_groups_partial_update + description: Patch a cluster group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster group. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedClusterGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedClusterGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterGroup' + description: '' + delete: + operationId: virtualization_cluster_groups_destroy + description: Delete a cluster group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster group. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/cluster-types/: + get: + operationId: virtualization_cluster_types_list + description: Get a list of cluster type objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedClusterTypeList' + description: '' + post: + operationId: virtualization_cluster_types_create + description: Post a list of cluster type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ClusterTypeRequest' + - type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/ClusterTypeRequest' + - type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterType' + description: '' + put: + operationId: virtualization_cluster_types_bulk_update + description: Put a list of cluster type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterType' + description: '' + patch: + operationId: virtualization_cluster_types_bulk_partial_update + description: Patch a list of cluster type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterType' + description: '' + delete: + operationId: virtualization_cluster_types_bulk_destroy + description: Delete a list of cluster type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/cluster-types/{id}/: + get: + operationId: virtualization_cluster_types_retrieve + description: Get a cluster type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster type. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterType' + description: '' + put: + operationId: virtualization_cluster_types_update + description: Put a cluster type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster type. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ClusterTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterType' + description: '' + patch: + operationId: virtualization_cluster_types_partial_update + description: Patch a cluster type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster type. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedClusterTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedClusterTypeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterType' + description: '' + delete: + operationId: virtualization_cluster_types_destroy + description: Delete a cluster type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster type. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/clusters/: + get: + operationId: virtualization_clusters_list + description: Get a list of cluster objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + description: Parent group (slug) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Parent group (slug) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + nullable: true + description: Parent group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Parent group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: scope_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__empty + schema: + type: boolean + - in: query + name: scope_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: scope_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 65a25166053759eb + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + description: Cluster type (slug) + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + description: Cluster type (slug) + explode: true + style: form + - in: query + name: type_id + schema: + type: array + items: + type: integer + description: Cluster type (ID) + explode: true + style: form + - in: query + name: type_id__n + schema: + type: array + items: + type: integer + description: Cluster type (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedClusterList' + description: '' + post: + operationId: virtualization_clusters_create + description: Post a list of cluster objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableClusterRequest' + - type: array + items: + $ref: '#/components/schemas/WritableClusterRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableClusterRequest' + - type: array + items: + $ref: '#/components/schemas/WritableClusterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + description: '' + put: + operationId: virtualization_clusters_bulk_update + description: Put a list of cluster objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Cluster' + description: '' + patch: + operationId: virtualization_clusters_bulk_partial_update + description: Patch a list of cluster objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Cluster' + description: '' + delete: + operationId: virtualization_clusters_bulk_destroy + description: Delete a list of cluster objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/ClusterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/clusters/{id}/: + get: + operationId: virtualization_clusters_retrieve + description: Get a cluster object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + description: '' + put: + operationId: virtualization_clusters_update + description: Put a cluster object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableClusterRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableClusterRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + description: '' + patch: + operationId: virtualization_clusters_partial_update + description: Patch a cluster object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableClusterRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableClusterRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + description: '' + delete: + operationId: virtualization_clusters_destroy + description: Delete a cluster object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this cluster. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/interfaces/: + get: + operationId: virtualization_interfaces_list + description: Get a list of interface objects. + parameters: + - in: query + name: bridge_id + schema: + type: array + items: + type: integer + description: Bridged interface (ID) + explode: true + style: form + - in: query + name: bridge_id__n + schema: + type: array + items: + type: integer + description: Bridged interface (ID) + explode: true + style: form + - in: query + name: cluster + schema: + type: array + items: + type: string + description: Cluster + explode: true + style: form + - in: query + name: cluster__n + schema: + type: array + items: + type: string + description: Cluster + explode: true + style: form + - in: query + name: cluster_id + schema: + type: array + items: + type: integer + description: Cluster (ID) + explode: true + style: form + - in: query + name: cluster_id__n + schema: + type: array + items: + type: integer + description: Cluster (ID) + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: enabled + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: l2vpn + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: L2VPN + explode: true + style: form + - in: query + name: l2vpn__n + schema: + type: array + items: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + description: L2VPN + explode: true + style: form + - in: query + name: l2vpn_id + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: l2vpn_id__n + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mac_address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mode + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__empty + schema: + type: boolean + description: 802.1Q Mode + - in: query + name: mode__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__n + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: mode__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: 802.1Q Mode + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: mtu + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__empty + schema: + type: boolean + - in: query + name: mtu__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: mtu__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + description: Parent interface (ID) + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + description: Parent interface (ID) + explode: true + style: form + - in: query + name: primary_mac_address + schema: + type: array + items: + type: string + description: Primary MAC address + explode: true + style: form + - in: query + name: primary_mac_address__n + schema: + type: array + items: + type: string + description: Primary MAC address + explode: true + style: form + - in: query + name: primary_mac_address_id + schema: + type: array + items: + type: integer + description: Primary MAC address (ID) + explode: true + style: form + - in: query + name: primary_mac_address_id__n + schema: + type: array + items: + type: integer + description: Primary MAC address (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine + schema: + type: array + items: + type: string + description: Virtual machine + explode: true + style: form + - in: query + name: virtual_machine__n + schema: + type: array + items: + type: string + description: Virtual machine + explode: true + style: form + - in: query + name: virtual_machine_id + schema: + type: array + items: + type: integer + description: Virtual machine (ID) + explode: true + style: form + - in: query + name: virtual_machine_id__n + schema: + type: array + items: + type: integer + description: Virtual machine (ID) + explode: true + style: form + - in: query + name: vlan + schema: + type: string + description: Assigned VID + - in: query + name: vlan_id + schema: + type: string + description: Assigned VLAN + - in: query + name: vlan_translation_policy + schema: + type: array + items: + type: string + description: VLAN Translation Policy + explode: true + style: form + - in: query + name: vlan_translation_policy__n + schema: + type: array + items: + type: string + description: VLAN Translation Policy + explode: true + style: form + - in: query + name: vlan_translation_policy_id + schema: + type: array + items: + type: integer + description: VLAN Translation Policy (ID) + explode: true + style: form + - in: query + name: vlan_translation_policy_id__n + schema: + type: array + items: + type: integer + description: VLAN Translation Policy (ID) + explode: true + style: form + - in: query + name: vrf + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf__n + schema: + type: array + items: + type: string + nullable: true + title: Route distinguisher + description: VRF (RD) + explode: true + style: form + - in: query + name: vrf_id + schema: + type: array + items: + type: integer + description: VRF + explode: true + style: form + - in: query + name: vrf_id__n + schema: + type: array + items: + type: integer + description: VRF + explode: true + style: form + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVMInterfaceList' + description: '' + post: + operationId: virtualization_interfaces_create + description: Post a list of interface objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVMInterfaceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVMInterfaceRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVMInterfaceRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVMInterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VMInterface' + description: '' + put: + operationId: virtualization_interfaces_bulk_update + description: Put a list of interface objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterfaceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterface' + description: '' + patch: + operationId: virtualization_interfaces_bulk_partial_update + description: Patch a list of interface objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterfaceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterface' + description: '' + delete: + operationId: virtualization_interfaces_bulk_destroy + description: Delete a list of interface objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterfaceRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VMInterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/interfaces/{id}/: + get: + operationId: virtualization_interfaces_retrieve + description: Get a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VMInterface' + description: '' + put: + operationId: virtualization_interfaces_update + description: Put a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVMInterfaceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVMInterfaceRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VMInterface' + description: '' + patch: + operationId: virtualization_interfaces_partial_update + description: Patch a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableVMInterfaceRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableVMInterfaceRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VMInterface' + description: '' + delete: + operationId: virtualization_interfaces_destroy + description: Delete a interface object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this interface. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/virtual-disks/: + get: + operationId: virtualization_virtual_disks_list + description: Get a list of virtual disk objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: size + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__empty + schema: + type: boolean + - in: query + name: size__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: size__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine + schema: + type: array + items: + type: string + description: Virtual machine + explode: true + style: form + - in: query + name: virtual_machine__n + schema: + type: array + items: + type: string + description: Virtual machine + explode: true + style: form + - in: query + name: virtual_machine_id + schema: + type: array + items: + type: integer + description: Virtual machine (ID) + explode: true + style: form + - in: query + name: virtual_machine_id__n + schema: + type: array + items: + type: integer + description: Virtual machine (ID) + explode: true + style: form + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualDiskList' + description: '' + post: + operationId: virtualization_virtual_disks_create + description: Post a list of virtual disk objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/VirtualDiskRequest' + - type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/VirtualDiskRequest' + - type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDisk' + description: '' + put: + operationId: virtualization_virtual_disks_bulk_update + description: Put a list of virtual disk objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDisk' + description: '' + patch: + operationId: virtualization_virtual_disks_bulk_partial_update + description: Patch a list of virtual disk objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDisk' + description: '' + delete: + operationId: virtualization_virtual_disks_bulk_destroy + description: Delete a list of virtual disk objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualDiskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/virtual-disks/{id}/: + get: + operationId: virtualization_virtual_disks_retrieve + description: Get a virtual disk object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual disk. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDisk' + description: '' + put: + operationId: virtualization_virtual_disks_update + description: Put a virtual disk object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual disk. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDiskRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/VirtualDiskRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDisk' + description: '' + patch: + operationId: virtualization_virtual_disks_partial_update + description: Patch a virtual disk object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual disk. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVirtualDiskRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedVirtualDiskRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualDisk' + description: '' + delete: + operationId: virtualization_virtual_disks_destroy + description: Delete a virtual disk object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual disk. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/virtual-machine-types/: + get: + operationId: virtualization_virtual_machine_types_list + description: Get a list of virtual machine type objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: default_memory + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: default_memory__empty + schema: + type: boolean + - in: query + name: default_memory__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: default_memory__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: default_memory__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: default_memory__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: default_memory__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: default_platform + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: default_platform__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: default_platform_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: default_platform_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: default_vcpus + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: default_vcpus__empty + schema: + type: boolean + - in: query + name: default_vcpus__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: default_vcpus__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: default_vcpus__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: default_vcpus__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: default_vcpus__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_machine_count__empty + schema: + type: boolean + - in: query + name: virtual_machine_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_machine_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_machine_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_machine_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_machine_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualMachineTypeList' + description: '' + post: + operationId: virtualization_virtual_machine_types_create + description: Post a list of virtual machine type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/VirtualMachineTypeRequest' + - type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/VirtualMachineTypeRequest' + - type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineType' + description: '' + put: + operationId: virtualization_virtual_machine_types_bulk_update + description: Put a list of virtual machine type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineType' + description: '' + patch: + operationId: virtualization_virtual_machine_types_bulk_partial_update + description: Patch a list of virtual machine type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineType' + description: '' + delete: + operationId: virtualization_virtual_machine_types_bulk_destroy + description: Delete a list of virtual machine type objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/virtual-machine-types/{id}/: + get: + operationId: virtualization_virtual_machine_types_retrieve + description: Get a virtual machine type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine type. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineType' + description: '' + put: + operationId: virtualization_virtual_machine_types_update + description: Put a virtual machine type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine type. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/VirtualMachineTypeRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineType' + description: '' + patch: + operationId: virtualization_virtual_machine_types_partial_update + description: Patch a virtual machine type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine type. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVirtualMachineTypeRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedVirtualMachineTypeRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineType' + description: '' + delete: + operationId: virtualization_virtual_machine_types_destroy + description: Delete a virtual machine type object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine type. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/virtual-machines/: + get: + operationId: virtualization_virtual_machines_list + description: Get a list of virtual machine objects. + parameters: + - in: query + name: cluster + schema: + type: array + items: + type: string + description: Cluster + explode: true + style: form + - in: query + name: cluster__n + schema: + type: array + items: + type: string + description: Cluster + explode: true + style: form + - in: query + name: cluster_group + schema: + type: array + items: + type: string + description: Cluster group (slug) + explode: true + style: form + - in: query + name: cluster_group__n + schema: + type: array + items: + type: string + description: Cluster group (slug) + explode: true + style: form + - in: query + name: cluster_group_id + schema: + type: array + items: + type: integer + description: Cluster group (ID) + explode: true + style: form + - in: query + name: cluster_group_id__n + schema: + type: array + items: + type: integer + description: Cluster group (ID) + explode: true + style: form + - in: query + name: cluster_id + schema: + type: array + items: + type: integer + nullable: true + description: Cluster (ID) + explode: true + style: form + - in: query + name: cluster_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Cluster (ID) + explode: true + style: form + - in: query + name: cluster_type + schema: + type: array + items: + type: string + description: Cluster type (slug) + explode: true + style: form + - in: query + name: cluster_type__n + schema: + type: array + items: + type: string + description: Cluster type (slug) + explode: true + style: form + - in: query + name: cluster_type_id + schema: + type: array + items: + type: integer + description: Cluster type (ID) + explode: true + style: form + - in: query + name: cluster_type_id__n + schema: + type: array + items: + type: integer + description: Cluster type (ID) + explode: true + style: form + - in: query + name: config_template_id + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: config_template_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Config template (ID) + explode: true + style: form + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + nullable: true + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Device (ID) + explode: true + style: form + - in: query + name: disk + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: disk__empty + schema: + type: boolean + - in: query + name: disk__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: disk__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: disk__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: disk__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: disk__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: has_primary_ip + schema: + type: boolean + description: Has a primary IP + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__empty + schema: + type: boolean + - in: query + name: interface_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: local_context_data + schema: + type: boolean + description: Has local config context data + - in: query + name: mac_address + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: mac_address__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: memory + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: memory__empty + schema: + type: boolean + - in: query + name: memory__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: memory__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: memory__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: memory__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: memory__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: platform + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: platform__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: platform_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: platform_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: primary_ip4 + schema: + type: array + items: + type: string + description: Primary IPv4 (address) + explode: true + style: form + - in: query + name: primary_ip4__n + schema: + type: array + items: + type: string + description: Primary IPv4 (address) + explode: true + style: form + - in: query + name: primary_ip4_id + schema: + type: array + items: + type: integer + description: Primary IPv4 (ID) + explode: true + style: form + - in: query + name: primary_ip4_id__n + schema: + type: array + items: + type: integer + description: Primary IPv4 (ID) + explode: true + style: form + - in: query + name: primary_ip6 + schema: + type: array + items: + type: string + description: Primary IPv6 (address) + explode: true + style: form + - in: query + name: primary_ip6__n + schema: + type: array + items: + type: string + description: Primary IPv6 (address) + explode: true + style: form + - in: query + name: primary_ip6_id + schema: + type: array + items: + type: integer + description: Primary IPv6 (ID) + explode: true + style: form + - in: query + name: primary_ip6_id__n + schema: + type: array + items: + type: integer + description: Primary IPv6 (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: role_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__empty + schema: + type: boolean + - in: query + name: serial__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: serial__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + nullable: true + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Site (ID) + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: start_on_boot + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__empty + schema: + type: boolean + - in: query + name: start_on_boot__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__n + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: start_on_boot__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 610e33fc2fde73d6 + explode: true + style: form + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: effecc3b94e0b74b + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vcpus + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: vcpus__empty + schema: + type: boolean + - in: query + name: vcpus__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: vcpus__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: vcpus__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: vcpus__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: vcpus__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: virtual_disk_count + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_disk_count__empty + schema: + type: boolean + - in: query + name: virtual_disk_count__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_disk_count__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_disk_count__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_disk_count__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_disk_count__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: virtual_machine_type + schema: + type: array + items: + type: string + description: Virtual machine type (slug) + explode: true + style: form + - in: query + name: virtual_machine_type__n + schema: + type: array + items: + type: string + description: Virtual machine type (slug) + explode: true + style: form + - in: query + name: virtual_machine_type_id + schema: + type: array + items: + type: integer + nullable: true + title: Type + description: Virtual machine type (ID) + explode: true + style: form + - in: query + name: virtual_machine_type_id__n + schema: + type: array + items: + type: integer + nullable: true + title: Type + description: Virtual machine type (ID) + explode: true + style: form + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVirtualMachineWithConfigContextList' + description: '' + post: + operationId: virtualization_virtual_machines_create + description: Post a list of virtual machine objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + - type: array + items: + $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + description: '' + put: + operationId: virtualization_virtual_machines_bulk_update + description: Put a list of virtual machine objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + description: '' + patch: + operationId: virtualization_virtual_machines_bulk_partial_update + description: Patch a list of virtual machine objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + description: '' + delete: + operationId: virtualization_virtual_machines_bulk_destroy + description: Delete a list of virtual machine objects. + tags: + - virtualization + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/virtual-machines/{id}/: + get: + operationId: virtualization_virtual_machines_retrieve + description: Get a virtual machine object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + description: '' + put: + operationId: virtualization_virtual_machines_update + description: Put a virtual machine object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + description: '' + patch: + operationId: virtualization_virtual_machines_partial_update + description: Patch a virtual machine object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + description: '' + delete: + operationId: virtualization_virtual_machines_destroy + description: Delete a virtual machine object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine. + required: true + tags: + - virtualization + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/virtualization/virtual-machines/{id}/render-config/: + post: + operationId: virtualization_virtual_machines_render_config_create + description: Resolve and render the preferred ConfigTemplate for this Device + or Virtual Machine. + parameters: + - in: query + name: format + schema: + type: string + enum: + - json + - txt + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this virtual machine. + required: true + tags: + - virtualization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + text/plain: + schema: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + description: '' + /api/vpn/ike-policies/: + get: + operationId: vpn_ike_policies_list + description: Get a list of IKE policy objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: ike_proposal + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ike_proposal__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ike_proposal_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: ike_proposal_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mode + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__empty + schema: + type: boolean + - in: query + name: mode__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__n + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: mode__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: preshared_key + schema: + type: string + - in: query + name: preshared_key__ic + schema: + type: string + - in: query + name: preshared_key__ie + schema: + type: string + - in: query + name: preshared_key__iew + schema: + type: string + - in: query + name: preshared_key__iregex + schema: + type: string + - in: query + name: preshared_key__isw + schema: + type: string + - in: query + name: preshared_key__n + schema: + type: string + - in: query + name: preshared_key__nic + schema: + type: string + - in: query + name: preshared_key__nie + schema: + type: string + - in: query + name: preshared_key__niew + schema: + type: string + - in: query + name: preshared_key__nisw + schema: + type: string + - in: query + name: preshared_key__regex + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: version + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__ic + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__ie + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__iew + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__iregex + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__isw + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__n + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__nic + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__nie + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__niew + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__nisw + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + - in: query + name: version__regex + schema: + type: array + items: + type: integer + x-spec-enum-id: 00872b77916a1fde + explode: true + style: form + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedIKEPolicyList' + description: '' + post: + operationId: vpn_ike_policies_create + description: Post a list of IKE policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIKEPolicyRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIKEPolicyRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIKEPolicyRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIKEPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEPolicy' + description: '' + put: + operationId: vpn_ike_policies_bulk_update + description: Put a list of IKE policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicy' + description: '' + patch: + operationId: vpn_ike_policies_bulk_partial_update + description: Patch a list of IKE policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicy' + description: '' + delete: + operationId: vpn_ike_policies_bulk_destroy + description: Delete a list of IKE policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IKEPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ike-policies/{id}/: + get: + operationId: vpn_ike_policies_retrieve + description: Get a IKE policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE policy. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEPolicy' + description: '' + put: + operationId: vpn_ike_policies_update + description: Put a IKE policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE policy. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableIKEPolicyRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableIKEPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEPolicy' + description: '' + patch: + operationId: vpn_ike_policies_partial_update + description: Patch a IKE policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE policy. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableIKEPolicyRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableIKEPolicyRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEPolicy' + description: '' + delete: + operationId: vpn_ike_policies_destroy + description: Delete a IKE policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE policy. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ike-proposals/: + get: + operationId: vpn_ike_proposals_list + description: Get a list of IKE proposal objects. + parameters: + - in: query + name: authentication_algorithm + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__empty + schema: + type: boolean + - in: query + name: authentication_algorithm__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_algorithm__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + explode: true + style: form + - in: query + name: authentication_method + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__empty + schema: + type: boolean + - in: query + name: authentication_method__ic + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__ie + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__iew + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__isw + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__n + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__nic + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__nie + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__niew + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: authentication_method__regex + schema: + type: array + items: + type: string + x-spec-enum-id: a21158c52d0c455a + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: encryption_algorithm + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__empty + schema: + type: boolean + - in: query + name: encryption_algorithm__ic + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__ie + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__iew + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__isw + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__n + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__nic + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__nie + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__niew + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: encryption_algorithm__regex + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__ic + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__ie + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__iew + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__iregex + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__isw + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__nic + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__nie + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__niew + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__nisw + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: group__regex + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + description: Diffie-Hellman group ID + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: ike_policy + schema: + type: array + items: + type: string + description: IKE policy (name) + explode: true + style: form + - in: query + name: ike_policy__n + schema: + type: array + items: + type: string + description: IKE policy (name) + explode: true + style: form + - in: query + name: ike_policy_id + schema: + type: array + items: + type: integer + description: IKE policy (ID) + explode: true + style: form + - in: query + name: ike_policy_id__n + schema: + type: array + items: + type: integer + description: IKE policy (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: sa_lifetime + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime__empty + schema: + type: boolean + - in: query + name: sa_lifetime__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedIKEProposalList' + description: '' + post: + operationId: vpn_ike_proposals_create + description: Post a list of IKE proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIKEProposalRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIKEProposalRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIKEProposalRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIKEProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEProposal' + description: '' + put: + operationId: vpn_ike_proposals_bulk_update + description: Put a list of IKE proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposalRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposal' + description: '' + patch: + operationId: vpn_ike_proposals_bulk_partial_update + description: Patch a list of IKE proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposalRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposal' + description: '' + delete: + operationId: vpn_ike_proposals_bulk_destroy + description: Delete a list of IKE proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposalRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IKEProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ike-proposals/{id}/: + get: + operationId: vpn_ike_proposals_retrieve + description: Get a IKE proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE proposal. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEProposal' + description: '' + put: + operationId: vpn_ike_proposals_update + description: Put a IKE proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE proposal. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableIKEProposalRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableIKEProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEProposal' + description: '' + patch: + operationId: vpn_ike_proposals_partial_update + description: Patch a IKE proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE proposal. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableIKEProposalRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableIKEProposalRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IKEProposal' + description: '' + delete: + operationId: vpn_ike_proposals_destroy + description: Delete a IKE proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IKE proposal. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ipsec-policies/: + get: + operationId: vpn_ipsec_policies_list + description: Get a list of IPSec policy objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: ipsec_proposal + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ipsec_proposal__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ipsec_proposal_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: ipsec_proposal_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: pfs_group + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__ic + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__ie + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__iew + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__iregex + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__isw + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__n + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__nic + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__nie + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__niew + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__nisw + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: pfs_group__regex + schema: + type: array + items: + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: Diffie-Hellman group for Perfect Forward Secrecy + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedIPSecPolicyList' + description: '' + post: + operationId: vpn_ipsec_policies_create + description: Post a list of IPSec policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPSecPolicyRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPSecPolicyRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPSecPolicyRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPSecPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecPolicy' + description: '' + put: + operationId: vpn_ipsec_policies_bulk_update + description: Put a list of IPSec policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicy' + description: '' + patch: + operationId: vpn_ipsec_policies_bulk_partial_update + description: Patch a list of IPSec policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicy' + description: '' + delete: + operationId: vpn_ipsec_policies_bulk_destroy + description: Delete a list of IPSec policy objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicyRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ipsec-policies/{id}/: + get: + operationId: vpn_ipsec_policies_retrieve + description: Get a IPSec policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec policy. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecPolicy' + description: '' + put: + operationId: vpn_ipsec_policies_update + description: Put a IPSec policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec policy. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableIPSecPolicyRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableIPSecPolicyRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecPolicy' + description: '' + patch: + operationId: vpn_ipsec_policies_partial_update + description: Patch a IPSec policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec policy. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableIPSecPolicyRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableIPSecPolicyRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecPolicy' + description: '' + delete: + operationId: vpn_ipsec_policies_destroy + description: Delete a IPSec policy object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec policy. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ipsec-profiles/: + get: + operationId: vpn_ipsec_profiles_list + description: Get a list of IPSec profile objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: ike_policy + schema: + type: array + items: + type: string + description: IKE policy (name) + explode: true + style: form + - in: query + name: ike_policy__n + schema: + type: array + items: + type: string + description: IKE policy (name) + explode: true + style: form + - in: query + name: ike_policy_id + schema: + type: array + items: + type: integer + description: IKE policy (ID) + explode: true + style: form + - in: query + name: ike_policy_id__n + schema: + type: array + items: + type: integer + description: IKE policy (ID) + explode: true + style: form + - in: query + name: ipsec_policy + schema: + type: array + items: + type: string + description: IPSec policy (name) + explode: true + style: form + - in: query + name: ipsec_policy__n + schema: + type: array + items: + type: string + description: IPSec policy (name) + explode: true + style: form + - in: query + name: ipsec_policy_id + schema: + type: array + items: + type: integer + description: IPSec policy (ID) + explode: true + style: form + - in: query + name: ipsec_policy_id__n + schema: + type: array + items: + type: integer + description: IPSec policy (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: mode + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__empty + schema: + type: boolean + - in: query + name: mode__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__n + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: mode__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 87ac6ada0da14ccf + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedIPSecProfileList' + description: '' + post: + operationId: vpn_ipsec_profiles_create + description: Post a list of IPSec profile objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPSecProfileRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPSecProfileRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPSecProfileRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPSecProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProfile' + description: '' + put: + operationId: vpn_ipsec_profiles_bulk_update + description: Put a list of IPSec profile objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfile' + description: '' + patch: + operationId: vpn_ipsec_profiles_bulk_partial_update + description: Patch a list of IPSec profile objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfile' + description: '' + delete: + operationId: vpn_ipsec_profiles_bulk_destroy + description: Delete a list of IPSec profile objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfileRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ipsec-profiles/{id}/: + get: + operationId: vpn_ipsec_profiles_retrieve + description: Get a IPSec profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec profile. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProfile' + description: '' + put: + operationId: vpn_ipsec_profiles_update + description: Put a IPSec profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec profile. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableIPSecProfileRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableIPSecProfileRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProfile' + description: '' + patch: + operationId: vpn_ipsec_profiles_partial_update + description: Patch a IPSec profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec profile. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableIPSecProfileRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableIPSecProfileRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProfile' + description: '' + delete: + operationId: vpn_ipsec_profiles_destroy + description: Delete a IPSec profile object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec profile. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ipsec-proposals/: + get: + operationId: vpn_ipsec_proposals_list + description: Get a list of IPSec proposal objects. + parameters: + - in: query + name: authentication_algorithm + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__empty + schema: + type: boolean + - in: query + name: authentication_algorithm__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: authentication_algorithm__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: encryption_algorithm + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__empty + schema: + type: boolean + - in: query + name: encryption_algorithm__ic + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__ie + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__iew + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__isw + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__n + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__nic + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__nie + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__niew + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: encryption_algorithm__regex + schema: + type: array + items: + type: string + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: ipsec_policy + schema: + type: array + items: + type: string + description: IPSec policy (name) + explode: true + style: form + - in: query + name: ipsec_policy__n + schema: + type: array + items: + type: string + description: IPSec policy (name) + explode: true + style: form + - in: query + name: ipsec_policy_id + schema: + type: array + items: + type: integer + description: IPSec policy (ID) + explode: true + style: form + - in: query + name: ipsec_policy_id__n + schema: + type: array + items: + type: integer + description: IPSec policy (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: sa_lifetime_data + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_data__empty + schema: + type: boolean + - in: query + name: sa_lifetime_data__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_data__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_data__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_data__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_data__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_seconds + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_seconds__empty + schema: + type: boolean + - in: query + name: sa_lifetime_seconds__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_seconds__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_seconds__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_seconds__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: sa_lifetime_seconds__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedIPSecProposalList' + description: '' + post: + operationId: vpn_ipsec_proposals_create + description: Post a list of IPSec proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPSecProposalRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPSecProposalRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableIPSecProposalRequest' + - type: array + items: + $ref: '#/components/schemas/WritableIPSecProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProposal' + description: '' + put: + operationId: vpn_ipsec_proposals_bulk_update + description: Put a list of IPSec proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposalRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposal' + description: '' + patch: + operationId: vpn_ipsec_proposals_bulk_partial_update + description: Patch a list of IPSec proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposalRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposal' + description: '' + delete: + operationId: vpn_ipsec_proposals_bulk_destroy + description: Delete a list of IPSec proposal objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposalRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/IPSecProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/ipsec-proposals/{id}/: + get: + operationId: vpn_ipsec_proposals_retrieve + description: Get a IPSec proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec proposal. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProposal' + description: '' + put: + operationId: vpn_ipsec_proposals_update + description: Put a IPSec proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec proposal. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableIPSecProposalRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableIPSecProposalRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProposal' + description: '' + patch: + operationId: vpn_ipsec_proposals_partial_update + description: Patch a IPSec proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec proposal. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableIPSecProposalRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableIPSecProposalRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IPSecProposal' + description: '' + delete: + operationId: vpn_ipsec_proposals_destroy + description: Delete a IPSec proposal object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this IPSec proposal. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/l2vpn-terminations/: + get: + operationId: vpn_l2vpn_terminations_list + description: Get a list of L2VPN termination objects. + parameters: + - in: query + name: assigned_object_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__empty + schema: + type: boolean + - in: query + name: assigned_object_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: assigned_object_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned_object_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: assigned_object_type_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: assigned_object_type_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: device + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device__n + schema: + type: array + items: + type: string + nullable: true + description: Device (name) + explode: true + style: form + - in: query + name: device_id + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: device_id__n + schema: + type: array + items: + type: integer + description: Device (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface__n + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: l2vpn + schema: + type: array + items: + type: string + description: L2VPN (slug) + explode: true + style: form + - in: query + name: l2vpn__n + schema: + type: array + items: + type: string + description: L2VPN (slug) + explode: true + style: form + - in: query + name: l2vpn_id + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: l2vpn_id__n + schema: + type: array + items: + type: integer + description: L2VPN (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: virtual_machine + schema: + type: array + items: + type: string + description: Virtual machine (name) + explode: true + style: form + - in: query + name: virtual_machine__n + schema: + type: array + items: + type: string + description: Virtual machine (name) + explode: true + style: form + - in: query + name: virtual_machine_id + schema: + type: array + items: + type: integer + description: Virtual machine (ID) + explode: true + style: form + - in: query + name: virtual_machine_id__n + schema: + type: array + items: + type: integer + description: Virtual machine (ID) + explode: true + style: form + - in: query + name: vlan + schema: + type: array + items: + type: string + description: VLAN (name) + explode: true + style: form + - in: query + name: vlan__n + schema: + type: array + items: + type: string + description: VLAN (name) + explode: true + style: form + - in: query + name: vlan_id + schema: + type: array + items: + type: integer + description: VLAN (ID) + explode: true + style: form + - in: query + name: vlan_id__n + schema: + type: array + items: + type: integer + description: VLAN (ID) + explode: true + style: form + - in: query + name: vlan_vid + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__empty + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__gt + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__gte + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__lt + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__lte + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vlan_vid__n + schema: + type: integer + description: VLAN number (1-4094) + - in: query + name: vminterface + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface__n + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface_id + schema: + type: array + items: + type: integer + description: VM Interface (ID) + explode: true + style: form + - in: query + name: vminterface_id__n + schema: + type: array + items: + type: integer + description: VM Interface (ID) + explode: true + style: form + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedL2VPNTerminationList' + description: '' + post: + operationId: vpn_l2vpn_terminations_create + description: Post a list of L2VPN termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/L2VPNTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/L2VPNTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPNTermination' + description: '' + put: + operationId: vpn_l2vpn_terminations_bulk_update + description: Put a list of L2VPN termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTermination' + description: '' + patch: + operationId: vpn_l2vpn_terminations_bulk_partial_update + description: Patch a list of L2VPN termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTermination' + description: '' + delete: + operationId: vpn_l2vpn_terminations_bulk_destroy + description: Delete a list of L2VPN termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/l2vpn-terminations/{id}/: + get: + operationId: vpn_l2vpn_terminations_retrieve + description: Get a L2VPN termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN termination. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPNTermination' + description: '' + put: + operationId: vpn_l2vpn_terminations_update + description: Put a L2VPN termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN termination. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPNTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/L2VPNTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPNTermination' + description: '' + patch: + operationId: vpn_l2vpn_terminations_partial_update + description: Patch a L2VPN termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN termination. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedL2VPNTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedL2VPNTerminationRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPNTermination' + description: '' + delete: + operationId: vpn_l2vpn_terminations_destroy + description: Delete a L2VPN termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN termination. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/l2vpns/: + get: + operationId: vpn_l2vpns_list + description: Get a list of L2VPN objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: export_target + schema: + type: array + items: + type: string + description: Export target (name) + explode: true + style: form + - in: query + name: export_target__n + schema: + type: array + items: + type: string + description: Export target (name) + explode: true + style: form + - in: query + name: export_target_id + schema: + type: array + items: + type: integer + description: Export target + explode: true + style: form + - in: query + name: export_target_id__n + schema: + type: array + items: + type: integer + description: Export target + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__empty + schema: + type: boolean + - in: query + name: identifier__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: identifier__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: import_target + schema: + type: array + items: + type: string + description: Import target (name) + explode: true + style: form + - in: query + name: import_target__n + schema: + type: array + items: + type: string + description: Import target (name) + explode: true + style: form + - in: query + name: import_target_id + schema: + type: array + items: + type: integer + description: Import target + explode: true + style: form + - in: query + name: import_target_id__n + schema: + type: array + items: + type: integer + description: Import target + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 8b9dc8efc7c3d5b0 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: type + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__empty + schema: + type: boolean + - in: query + name: type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0a46f8056d717efc + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedL2VPNList' + description: '' + post: + operationId: vpn_l2vpns_create + description: Post a list of L2VPN objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableL2VPNRequest' + - type: array + items: + $ref: '#/components/schemas/WritableL2VPNRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableL2VPNRequest' + - type: array + items: + $ref: '#/components/schemas/WritableL2VPNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPN' + description: '' + put: + operationId: vpn_l2vpns_bulk_update + description: Put a list of L2VPN objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPN' + description: '' + patch: + operationId: vpn_l2vpns_bulk_partial_update + description: Patch a list of L2VPN objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPN' + description: '' + delete: + operationId: vpn_l2vpns_bulk_destroy + description: Delete a list of L2VPN objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/L2VPNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/l2vpns/{id}/: + get: + operationId: vpn_l2vpns_retrieve + description: Get a L2VPN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPN' + description: '' + put: + operationId: vpn_l2vpns_update + description: Put a L2VPN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableL2VPNRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableL2VPNRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPN' + description: '' + patch: + operationId: vpn_l2vpns_partial_update + description: Patch a L2VPN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableL2VPNRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableL2VPNRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/L2VPN' + description: '' + delete: + operationId: vpn_l2vpns_destroy + description: Delete a L2VPN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this L2VPN. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/tunnel-groups/: + get: + operationId: vpn_tunnel_groups_list + description: Get a list of tunnel group objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTunnelGroupList' + description: '' + post: + operationId: vpn_tunnel_groups_create + description: Post a list of tunnel group objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/TunnelGroupRequest' + - type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/TunnelGroupRequest' + - type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelGroup' + description: '' + put: + operationId: vpn_tunnel_groups_bulk_update + description: Put a list of tunnel group objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroup' + description: '' + patch: + operationId: vpn_tunnel_groups_bulk_partial_update + description: Patch a list of tunnel group objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroup' + description: '' + delete: + operationId: vpn_tunnel_groups_bulk_destroy + description: Delete a list of tunnel group objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/tunnel-groups/{id}/: + get: + operationId: vpn_tunnel_groups_retrieve + description: Get a tunnel group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel group. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelGroup' + description: '' + put: + operationId: vpn_tunnel_groups_update + description: Put a tunnel group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel group. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TunnelGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelGroup' + description: '' + patch: + operationId: vpn_tunnel_groups_partial_update + description: Patch a tunnel group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel group. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedTunnelGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedTunnelGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelGroup' + description: '' + delete: + operationId: vpn_tunnel_groups_destroy + description: Delete a tunnel group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel group. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/tunnel-terminations/: + get: + operationId: vpn_tunnel_terminations_list + description: Get a list of tunnel termination objects. + parameters: + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface__n + schema: + type: array + items: + type: string + description: Interface (name) + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + description: Interface (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: outside_ip_id + schema: + type: array + items: + type: integer + description: Outside IP (ID) + explode: true + style: form + - in: query + name: outside_ip_id__n + schema: + type: array + items: + type: integer + description: Outside IP (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: role + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__empty + schema: + type: boolean + - in: query + name: role__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__n + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - in: query + name: role__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 0b3bfadcebd86b58 + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: termination_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__empty + schema: + type: boolean + - in: query + name: termination_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: termination_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: termination_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tunnel + schema: + type: array + items: + type: string + description: Tunnel (name) + explode: true + style: form + - in: query + name: tunnel__n + schema: + type: array + items: + type: string + description: Tunnel (name) + explode: true + style: form + - in: query + name: tunnel_id + schema: + type: array + items: + type: integer + description: Tunnel (ID) + explode: true + style: form + - in: query + name: tunnel_id__n + schema: + type: array + items: + type: integer + description: Tunnel (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vminterface + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface__n + schema: + type: array + items: + type: string + description: VM interface (name) + explode: true + style: form + - in: query + name: vminterface_id + schema: + type: array + items: + type: integer + description: VM interface (ID) + explode: true + style: form + - in: query + name: vminterface_id__n + schema: + type: array + items: + type: integer + description: VM interface (ID) + explode: true + style: form + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTunnelTerminationList' + description: '' + post: + operationId: vpn_tunnel_terminations_create + description: Post a list of tunnel termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableTunnelTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableTunnelTerminationRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableTunnelTerminationRequest' + - type: array + items: + $ref: '#/components/schemas/WritableTunnelTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelTermination' + description: '' + put: + operationId: vpn_tunnel_terminations_bulk_update + description: Put a list of tunnel termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTermination' + description: '' + patch: + operationId: vpn_tunnel_terminations_bulk_partial_update + description: Patch a list of tunnel termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTermination' + description: '' + delete: + operationId: vpn_tunnel_terminations_bulk_destroy + description: Delete a list of tunnel termination objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTerminationRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/tunnel-terminations/{id}/: + get: + operationId: vpn_tunnel_terminations_retrieve + description: Get a tunnel termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel termination. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelTermination' + description: '' + put: + operationId: vpn_tunnel_terminations_update + description: Put a tunnel termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel termination. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableTunnelTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableTunnelTerminationRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelTermination' + description: '' + patch: + operationId: vpn_tunnel_terminations_partial_update + description: Patch a tunnel termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel termination. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableTunnelTerminationRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableTunnelTerminationRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TunnelTermination' + description: '' + delete: + operationId: vpn_tunnel_terminations_destroy + description: Delete a tunnel termination object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel termination. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/tunnels/: + get: + operationId: vpn_tunnels_list + description: Get a list of tunnel objects. + parameters: + - in: query + name: contact + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact__n + schema: + type: array + items: + type: integer + description: Contact + explode: true + style: form + - in: query + name: contact_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: contact_role + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: contact_role__n + schema: + type: array + items: + type: integer + description: Contact Role + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: encapsulation + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__empty + schema: + type: boolean + - in: query + name: encapsulation__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__n + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: encapsulation__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 4f3254459f0e94f0 + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + description: Tunnel group (slug) + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + description: Tunnel group (slug) + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: integer + nullable: true + description: Tunnel group (ID) + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tunnel group (ID) + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: ipsec_profile + schema: + type: array + items: + type: string + description: IPSec profile (name) + explode: true + style: form + - in: query + name: ipsec_profile__n + schema: + type: array + items: + type: string + description: IPSec profile (name) + explode: true + style: form + - in: query + name: ipsec_profile_id + schema: + type: array + items: + type: integer + nullable: true + description: IPSec profile (ID) + explode: true + style: form + - in: query + name: ipsec_profile_id__n + schema: + type: array + items: + type: integer + nullable: true + description: IPSec profile (ID) + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 2431ef62c418f485 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tunnel_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tunnel_id__empty + schema: + type: boolean + - in: query + name: tunnel_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tunnel_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tunnel_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tunnel_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: tunnel_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedTunnelList' + description: '' + post: + operationId: vpn_tunnels_create + description: Post a list of tunnel objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableTunnelRequest' + - type: array + items: + $ref: '#/components/schemas/WritableTunnelRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableTunnelRequest' + - type: array + items: + $ref: '#/components/schemas/WritableTunnelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Tunnel' + description: '' + put: + operationId: vpn_tunnels_bulk_update + description: Put a list of tunnel objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tunnel' + description: '' + patch: + operationId: vpn_tunnels_bulk_partial_update + description: Patch a list of tunnel objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tunnel' + description: '' + delete: + operationId: vpn_tunnels_bulk_destroy + description: Delete a list of tunnel objects. + tags: + - vpn + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/TunnelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/vpn/tunnels/{id}/: + get: + operationId: vpn_tunnels_retrieve + description: Get a tunnel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tunnel' + description: '' + put: + operationId: vpn_tunnels_update + description: Put a tunnel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableTunnelRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableTunnelRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tunnel' + description: '' + patch: + operationId: vpn_tunnels_partial_update + description: Patch a tunnel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel. + required: true + tags: + - vpn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableTunnelRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableTunnelRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Tunnel' + description: '' + delete: + operationId: vpn_tunnels_destroy + description: Delete a tunnel object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this tunnel. + required: true + tags: + - vpn + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/wireless/wireless-lan-groups/: + get: + operationId: wireless_wireless_lan_groups_list + description: Get a list of wireless LAN group objects. + parameters: + - in: query + name: ancestor + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ancestor_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__empty + schema: + type: boolean + - in: query + name: name__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: name__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: parent + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: parent__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: parent_id + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - in: query + name: parent_id__n + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: slug + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__empty + schema: + type: boolean + - in: query + name: slug__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: slug__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedWirelessLANGroupList' + description: '' + post: + operationId: wireless_wireless_lan_groups_create + description: Post a list of wireless LAN group objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableWirelessLANGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableWirelessLANGroupRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableWirelessLANGroupRequest' + - type: array + items: + $ref: '#/components/schemas/WritableWirelessLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLANGroup' + description: '' + put: + operationId: wireless_wireless_lan_groups_bulk_update + description: Put a list of wireless LAN group objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroup' + description: '' + patch: + operationId: wireless_wireless_lan_groups_bulk_partial_update + description: Patch a list of wireless LAN group objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroup' + description: '' + delete: + operationId: wireless_wireless_lan_groups_bulk_destroy + description: Delete a list of wireless LAN group objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroupRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/wireless/wireless-lan-groups/{id}/: + get: + operationId: wireless_wireless_lan_groups_retrieve + description: Get a wireless LAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN group. + required: true + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLANGroup' + description: '' + put: + operationId: wireless_wireless_lan_groups_update + description: Put a wireless LAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN group. + required: true + tags: + - wireless + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableWirelessLANGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableWirelessLANGroupRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLANGroup' + description: '' + patch: + operationId: wireless_wireless_lan_groups_partial_update + description: Patch a wireless LAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN group. + required: true + tags: + - wireless + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableWirelessLANGroupRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableWirelessLANGroupRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLANGroup' + description: '' + delete: + operationId: wireless_wireless_lan_groups_destroy + description: Delete a wireless LAN group object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN group. + required: true + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/wireless/wireless-lans/: + get: + operationId: wireless_wireless_lans_list + description: Get a list of wireless LAN objects. + parameters: + - in: query + name: auth_cipher + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__empty + schema: + type: boolean + - in: query + name: auth_cipher__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__n + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_psk + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__empty + schema: + type: boolean + - in: query + name: auth_psk__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_type + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__empty + schema: + type: boolean + - in: query + name: auth_type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__n + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: interface_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: location + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: location_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: region + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: region_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: scope_id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__empty + schema: + type: boolean + - in: query + name: scope_id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: scope_type + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: scope_type__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site__n + schema: + type: array + items: + type: string + description: Site (slug) + explode: true + style: form + - in: query + name: site_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: site_id + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: site_id__n + schema: + type: array + items: + type: integer + description: Site (ID) + explode: true + style: form + - in: query + name: ssid + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__empty + schema: + type: boolean + - in: query + name: ssid__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: e5549d7370ce2e6c + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + - in: query + name: vlan_id + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - in: query + name: vlan_id__n + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedWirelessLANList' + description: '' + post: + operationId: wireless_wireless_lans_create + description: Post a list of wireless LAN objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableWirelessLANRequest' + - type: array + items: + $ref: '#/components/schemas/WritableWirelessLANRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableWirelessLANRequest' + - type: array + items: + $ref: '#/components/schemas/WritableWirelessLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLAN' + description: '' + put: + operationId: wireless_wireless_lans_bulk_update + description: Put a list of wireless LAN objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLAN' + description: '' + patch: + operationId: wireless_wireless_lans_bulk_partial_update + description: Patch a list of wireless LAN objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLAN' + description: '' + delete: + operationId: wireless_wireless_lans_bulk_destroy + description: Delete a list of wireless LAN objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/wireless/wireless-lans/{id}/: + get: + operationId: wireless_wireless_lans_retrieve + description: Get a wireless LAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN. + required: true + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLAN' + description: '' + put: + operationId: wireless_wireless_lans_update + description: Put a wireless LAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN. + required: true + tags: + - wireless + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableWirelessLANRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableWirelessLANRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLAN' + description: '' + patch: + operationId: wireless_wireless_lans_partial_update + description: Patch a wireless LAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN. + required: true + tags: + - wireless + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableWirelessLANRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableWirelessLANRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLAN' + description: '' + delete: + operationId: wireless_wireless_lans_destroy + description: Delete a wireless LAN object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless LAN. + required: true + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/wireless/wireless-links/: + get: + operationId: wireless_wireless_links_list + description: Get a list of wireless link objects. + parameters: + - in: query + name: auth_cipher + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__empty + schema: + type: boolean + - in: query + name: auth_cipher__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__n + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_cipher__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + explode: true + style: form + - in: query + name: auth_psk + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__empty + schema: + type: boolean + - in: query + name: auth_psk__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_psk__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: auth_type + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__empty + schema: + type: boolean + - in: query + name: auth_type__ic + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__ie + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__iew + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__isw + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__n + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nic + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nie + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__niew + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: auth_type__regex + schema: + type: array + items: + type: string + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + explode: true + style: form + - in: query + name: created + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: created_by_request + schema: + type: string + format: uuid + - in: query + name: description + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__empty + schema: + type: boolean + - in: query + name: description__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: description__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__empty + schema: + type: boolean + - in: query + name: distance__gt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__gte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__lt + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__lte + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance__n + schema: + type: array + items: + type: number + format: double + explode: true + style: form + - in: query + name: distance_unit + schema: + type: string + x-spec-enum-id: b1169a409430c02e + nullable: true + enum: + - ft + - km + - m + - mi + - 'null' + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + - in: query + name: distance_unit__empty + schema: + type: boolean + - in: query + name: distance_unit__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__n + schema: + type: string + x-spec-enum-id: b1169a409430c02e + nullable: true + enum: + - ft + - km + - m + - mi + - 'null' + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + - in: query + name: distance_unit__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: distance_unit__regex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__empty + schema: + type: boolean + - in: query + name: id__gt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__gte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lt + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__lte + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: id__n + schema: + type: array + items: + type: integer + format: int32 + explode: true + style: form + - in: query + name: interface_a_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: interface_a_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: interface_b_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: interface_b_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: last_updated + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__empty + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__gte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lt + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__lte + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - in: query + name: last_updated__n + schema: + type: array + items: + type: string + format: date-time + explode: true + style: form + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: modified_by_request + schema: + type: string + format: uuid + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - in: query + name: owner + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner__n + schema: + type: array + items: + type: string + description: Owner (name) + explode: true + style: form + - in: query + name: owner_group + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group__n + schema: + type: array + items: + type: string + description: Owner Group (name) + explode: true + style: form + - in: query + name: owner_group_id + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_group_id__n + schema: + type: array + items: + type: integer + description: Owner Group (ID) + explode: true + style: form + - in: query + name: owner_id + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: owner_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Owner (ID) + explode: true + style: form + - in: query + name: q + schema: + type: string + description: Search + - in: query + name: ssid + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__empty + schema: + type: boolean + - in: query + name: ssid__ic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__ie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__iew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__iregex + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__isw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__nic + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__nie + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__niew + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__nisw + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: ssid__regex + schema: + type: array + items: + type: string + explode: true + style: form + - name: start + required: false + in: query + description: 'Cursor-based pagination: return results with pk >= start, ordered + by pk. Mutually exclusive with offset.' + schema: + type: integer + - in: query + name: status + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__empty + schema: + type: boolean + - in: query + name: status__ic + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__ie + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__iew + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__iregex + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__isw + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__n + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__nic + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__nie + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__niew + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__nisw + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: status__regex + schema: + type: array + items: + type: string + x-spec-enum-id: 80d251a40f3a3144 + explode: true + style: form + - in: query + name: tag + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tag_id + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tag_id__n + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: tenant + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant__n + schema: + type: array + items: + type: string + description: Tenant (slug) + explode: true + style: form + - in: query + name: tenant_group + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_group_id__n + schema: + type: array + items: + type: string + explode: true + style: form + - in: query + name: tenant_id + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: tenant_id__n + schema: + type: array + items: + type: integer + nullable: true + description: Tenant (ID) + explode: true + style: form + - in: query + name: updated_by_request + schema: + type: string + format: uuid + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedWirelessLinkList' + description: '' + post: + operationId: wireless_wireless_links_create + description: Post a list of wireless link objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/WritableWirelessLinkRequest' + - type: array + items: + $ref: '#/components/schemas/WritableWirelessLinkRequest' + multipart/form-data: + schema: + oneOf: + - $ref: '#/components/schemas/WritableWirelessLinkRequest' + - type: array + items: + $ref: '#/components/schemas/WritableWirelessLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLink' + description: '' + put: + operationId: wireless_wireless_links_bulk_update + description: Put a list of wireless link objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLinkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLink' + description: '' + patch: + operationId: wireless_wireless_links_bulk_partial_update + description: Patch a list of wireless link objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLinkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLink' + description: '' + delete: + operationId: wireless_wireless_links_bulk_destroy + description: Delete a list of wireless link objects. + tags: + - wireless + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLinkRequest' + multipart/form-data: + schema: + type: array + items: + $ref: '#/components/schemas/WirelessLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body + /api/wireless/wireless-links/{id}/: + get: + operationId: wireless_wireless_links_retrieve + description: Get a wireless link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless link. + required: true + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLink' + description: '' + put: + operationId: wireless_wireless_links_update + description: Put a wireless link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless link. + required: true + tags: + - wireless + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WritableWirelessLinkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WritableWirelessLinkRequest' + required: true + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLink' + description: '' + patch: + operationId: wireless_wireless_links_partial_update + description: Patch a wireless link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless link. + required: true + tags: + - wireless + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWritableWirelessLinkRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWritableWirelessLinkRequest' + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WirelessLink' + description: '' + delete: + operationId: wireless_wireless_links_destroy + description: Delete a wireless link object. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this wireless link. + required: true + tags: + - wireless + security: + - cookieAuth: [] + - tokenAuth: [] + responses: + '204': + description: No response body +components: + schemas: + ASN: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + asn: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + description: 16- or 32-bit autonomous system number + rir: + allOf: + - $ref: '#/components/schemas/BriefRIR' + nullable: true + role: + allOf: + - $ref: '#/components/schemas/BriefRole' + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + site_count: + type: integer + format: int64 + readOnly: true + provider_count: + type: integer + format: int64 + readOnly: true + sites: + type: array + items: + $ref: '#/components/schemas/ASNSite' + required: + - asn + - created + - display + - display_url + - id + - last_updated + - provider_count + - site_count + - url + ASNRange: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + rir: + $ref: '#/components/schemas/BriefRIR' + start: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + end: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + asn_count: + type: integer + readOnly: true + required: + - asn_count + - created + - display + - display_url + - end + - id + - last_updated + - name + - rir + - slug + - start + - url + ASNRangeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + rir: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRIRRequest' + start: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + end: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - end + - name + - rir + - slug + - start + ASNRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + asn: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + description: 16- or 32-bit autonomous system number + rir: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRIRRequest' + nullable: true + nullable: true + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + sites: + type: array + items: + type: integer + required: + - asn + ASNSite: + type: object + description: |- + This serializer is meant for inclusion in ASNSerializer and is only used + to avoid a circular import of SiteSerializer. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: Full name of the site + maxLength: 100 + description: + type: string + maxLength: 200 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + required: + - display + - id + - name + - slug + - url + Aggregate: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + family: + type: object + properties: + value: + enum: + - 4 + - 6 + type: integer + description: |- + * `4` - IPv4 + * `6` - IPv6 + x-spec-enum-id: d72003fd1af3603d + label: + type: string + enum: + - IPv4 + - IPv6 + readOnly: true + prefix: + type: string + rir: + $ref: '#/components/schemas/BriefRIR' + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + date_added: + type: string + format: date + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - family + - id + - last_updated + - prefix + - rir + - url + AggregateRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + prefix: + type: string + minLength: 1 + rir: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRIRRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + date_added: + type: string + format: date + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - prefix + - rir + AvailableASN: + type: object + description: Representation of an ASN which does not exist in the database. + properties: + asn: + type: integer + readOnly: true + description: + type: string + required: + - asn + AvailableIP: + type: object + description: Representation of an IP address which does not exist in the database. + properties: + family: + type: integer + readOnly: true + address: + type: string + readOnly: true + vrf: + allOf: + - $ref: '#/components/schemas/BriefVRF' + readOnly: true + nullable: true + description: + type: string + required: + - address + - family + - vrf + AvailableIPRequestRequest: + type: object + description: Request payload for creating IP addresses from the available-ips + endpoint. + properties: + prefix_length: + type: integer + AvailablePrefix: + type: object + description: Representation of a prefix which does not exist in the database. + properties: + family: + type: integer + readOnly: true + prefix: + type: string + readOnly: true + vrf: + allOf: + - $ref: '#/components/schemas/BriefVRF' + readOnly: true + nullable: true + required: + - family + - prefix + - vrf + AvailableVLAN: + type: object + description: Representation of a VLAN which does not exist in the database. + properties: + vid: + type: integer + readOnly: true + group: + allOf: + - $ref: '#/components/schemas/BriefVLANGroup' + readOnly: true + nullable: true + required: + - group + - vid + BackgroundTask: + type: object + properties: + id: + type: string + url: + type: string + format: uri + readOnly: true + description: + type: string + origin: + type: string + func_name: + type: string + args: + type: array + items: {} + readOnly: true + kwargs: + type: object + additionalProperties: {} + readOnly: true + result: + type: string + timeout: + type: integer + result_ttl: + type: integer + created_at: + type: string + format: date-time + enqueued_at: + type: string + format: date-time + started_at: + type: string + format: date-time + ended_at: + type: string + format: date-time + worker_name: + type: string + position: + type: integer + readOnly: true + status: + type: string + readOnly: true + meta: + type: object + additionalProperties: {} + last_heartbeat: + type: string + is_finished: + type: boolean + is_queued: + type: boolean + is_failed: + type: boolean + is_started: + type: boolean + is_deferred: + type: boolean + is_canceled: + type: boolean + is_scheduled: + type: boolean + is_stopped: + type: boolean + required: + - args + - created_at + - description + - ended_at + - enqueued_at + - func_name + - id + - is_canceled + - is_deferred + - is_failed + - is_finished + - is_queued + - is_scheduled + - is_started + - is_stopped + - kwargs + - last_heartbeat + - meta + - origin + - position + - result + - result_ttl + - started_at + - status + - timeout + - url + - worker_name + BackgroundTaskRequest: + type: object + properties: + id: + type: string + minLength: 1 + description: + type: string + minLength: 1 + origin: + type: string + minLength: 1 + func_name: + type: string + minLength: 1 + result: + type: string + minLength: 1 + timeout: + type: integer + result_ttl: + type: integer + created_at: + type: string + format: date-time + enqueued_at: + type: string + format: date-time + started_at: + type: string + format: date-time + ended_at: + type: string + format: date-time + worker_name: + type: string + minLength: 1 + meta: + type: object + additionalProperties: {} + last_heartbeat: + type: string + minLength: 1 + is_finished: + type: boolean + is_queued: + type: boolean + is_failed: + type: boolean + is_started: + type: boolean + is_deferred: + type: boolean + is_canceled: + type: boolean + is_scheduled: + type: boolean + is_stopped: + type: boolean + required: + - created_at + - description + - ended_at + - enqueued_at + - func_name + - id + - is_canceled + - is_deferred + - is_failed + - is_finished + - is_queued + - is_scheduled + - is_started + - is_stopped + - last_heartbeat + - meta + - origin + - result + - result_ttl + - started_at + - timeout + - worker_name + Bookmark: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + object: + readOnly: true + nullable: true + user: + $ref: '#/components/schemas/BriefUser' + created: + type: string + format: date-time + readOnly: true + required: + - created + - display + - id + - object + - object_id + - object_type + - url + - user + BookmarkRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + required: + - object_id + - object_type + - user + BriefCable: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + label: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - url + BriefCableBundle: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefCableBundleRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefCableRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + label: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + BriefCircuit: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + cid: + type: string + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider: + $ref: '#/components/schemas/BriefProvider' + description: + type: string + maxLength: 200 + required: + - cid + - display + - id + - provider + - url + BriefCircuitGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + required: + - display + - id + - name + - url + BriefCircuitGroupAssignmentSerializer_: + type: object + description: Base serializer for group assignments under CircuitSerializer. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + group: + $ref: '#/components/schemas/BriefCircuitGroup' + priority: + type: object + properties: + value: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + label: + type: string + enum: + - Primary + - Secondary + - Tertiary + - Inactive + required: + - display + - group + - id + - url + BriefCircuitGroupAssignmentSerializer_Request: + type: object + description: Base serializer for group assignments under CircuitSerializer. + properties: + group: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitGroupRequest' + priority: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + required: + - group + BriefCircuitGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + required: + - name + BriefCircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + description: + type: string + maxLength: 200 + required: + - cid + - provider + BriefCircuitType: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + circuit_count: + type: integer + format: int64 + readOnly: true + required: + - circuit_count + - display + - id + - name + - slug + - url + BriefCircuitTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefCluster: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + virtualmachine_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - url + - virtualmachine_count + BriefClusterGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + cluster_count: + type: integer + format: int64 + readOnly: true + required: + - cluster_count + - display + - id + - name + - slug + - url + BriefClusterGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefClusterRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefClusterType: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + cluster_count: + type: integer + format: int64 + readOnly: true + required: + - cluster_count + - display + - id + - name + - slug + - url + BriefClusterTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefConfigContextProfile: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefConfigContextProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefConfigTemplate: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefConfigTemplateRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefContact: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefContactRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefContactRole: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - slug + - url + BriefContactRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefCustomFieldChoiceSet: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + choices_count: + type: integer + readOnly: true + required: + - choices_count + - display + - id + - name + - url + BriefCustomFieldChoiceSetRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefDataFile: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + path: + type: string + readOnly: true + description: File path relative to the data source's root + required: + - display + - id + - path + - url + BriefDataSource: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefDataSourceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefDevice: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + nullable: true + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - display + - id + - url + BriefDeviceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + nullable: true + maxLength: 64 + description: + type: string + maxLength: 200 + BriefDeviceRole: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + device_count: + type: integer + readOnly: true + default: 0 + virtualmachine_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - device_count + - display + - id + - name + - slug + - url + - virtualmachine_count + BriefDeviceRoleRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefDeviceType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + manufacturer: + $ref: '#/components/schemas/BriefManufacturer' + model: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + device_count: + type: integer + readOnly: true + required: + - device_count + - display + - id + - manufacturer + - model + - slug + - url + BriefDeviceTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - manufacturer + - model + - slug + BriefFHRPGroup: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + protocol: + enum: + - vrrp2 + - vrrp3 + - carp + - clusterxl + - hsrp + - glbp + - other + type: string + description: |- + * `vrrp2` - VRRPv2 + * `vrrp3` - VRRPv3 + * `carp` - CARP + * `clusterxl` - ClusterXL + * `hsrp` - HSRP + * `glbp` - GLBP + * `other` - Other + x-spec-enum-id: 98de93c9f65d1c65 + group_id: + type: integer + maximum: 32767 + minimum: 0 + description: + type: string + maxLength: 200 + required: + - display + - group_id + - id + - protocol + - url + BriefFHRPGroupRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + protocol: + enum: + - vrrp2 + - vrrp3 + - carp + - clusterxl + - hsrp + - glbp + - other + type: string + description: |- + * `vrrp2` - VRRPv2 + * `vrrp3` - VRRPv3 + * `carp` - CARP + * `clusterxl` - ClusterXL + * `hsrp` - HSRP + * `glbp` - GLBP + * `other` - Other + x-spec-enum-id: 98de93c9f65d1c65 + group_id: + type: integer + maximum: 32767 + minimum: 0 + description: + type: string + maxLength: 200 + required: + - group_id + - protocol + BriefIKEPolicy: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefIKEPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefIPAddress: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + family: + type: object + properties: + value: + enum: + - 4 + - 6 + type: integer + description: |- + * `4` - IPv4 + * `6` - IPv6 + x-spec-enum-id: d72003fd1af3603d + label: + type: string + enum: + - IPv4 + - IPv6 + readOnly: true + address: + type: string + nat_inside: + allOf: + - $ref: '#/components/schemas/NestedIPAddress' + nullable: true + nat_outside: + type: array + items: + $ref: '#/components/schemas/NestedIPAddress' + readOnly: true + description: + type: string + maxLength: 200 + required: + - address + - display + - family + - id + - nat_outside + - url + BriefIPAddressRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + address: + type: string + minLength: 1 + nat_inside: + allOf: + - $ref: '#/components/schemas/NestedIPAddressRequest' + nullable: true + description: + type: string + maxLength: 200 + required: + - address + BriefIPSecPolicy: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefIPSecPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefIPSecProfile: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefIPSecProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefInterface: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + name: + type: string + maxLength: 64 + description: + type: string + maxLength: 200 + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - device + - display + - id + - name + - url + BriefInterfaceRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - device + - name + BriefInventoryItemRole: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + inventoryitem_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - inventoryitem_count + - name + - slug + - url + BriefInventoryItemRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefJob: + type: object + properties: + url: + type: string + format: uri + readOnly: true + status: + type: object + properties: + value: + enum: + - pending + - scheduled + - running + - completed + - errored + - failed + type: string + description: |- + * `pending` - Pending + * `scheduled` - Scheduled + * `running` - Running + * `completed` - Completed + * `errored` - Errored + * `failed` - Failed + x-spec-enum-id: b3049df95b935eab + label: + type: string + enum: + - Pending + - Scheduled + - Running + - Completed + - Errored + - Failed + readOnly: true + created: + type: string + format: date-time + readOnly: true + completed: + type: string + format: date-time + nullable: true + user: + allOf: + - $ref: '#/components/schemas/BriefUser' + readOnly: true + required: + - created + - status + - url + - user + BriefJobRequest: + type: object + properties: + completed: + type: string + format: date-time + nullable: true + BriefL2VPN: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + identifier: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + type: + type: object + properties: + value: + enum: + - vpws + - vpls + - vxlan + - vxlan-evpn + - mpls-evpn + - pbb-evpn + - evpn-vpws + - epl + - evpl + - ep-lan + - evp-lan + - ep-tree + - evp-tree + - spb + type: string + description: |- + * `vpws` - VPWS + * `vpls` - VPLS + * `vxlan` - VXLAN + * `vxlan-evpn` - VXLAN-EVPN + * `mpls-evpn` - MPLS EVPN + * `pbb-evpn` - PBB EVPN + * `evpn-vpws` - EVPN VPWS + * `epl` - EPL + * `evpl` - EVPL + * `ep-lan` - Ethernet Private LAN + * `evp-lan` - Ethernet Virtual Private LAN + * `ep-tree` - Ethernet Private Tree + * `evp-tree` - Ethernet Virtual Private Tree + * `spb` - SPB + x-spec-enum-id: 0a46f8056d717efc + label: + type: string + enum: + - VPWS + - VPLS + - VXLAN + - VXLAN-EVPN + - MPLS EVPN + - PBB EVPN + - EVPN VPWS + - EPL + - EVPL + - Ethernet Private LAN + - Ethernet Virtual Private LAN + - Ethernet Private Tree + - Ethernet Virtual Private Tree + - SPB + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - slug + - url + BriefL2VPNRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + identifier: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + type: + enum: + - vpws + - vpls + - vxlan + - vxlan-evpn + - mpls-evpn + - pbb-evpn + - evpn-vpws + - epl + - evpl + - ep-lan + - evp-lan + - ep-tree + - evp-tree + - spb + type: string + description: |- + * `vpws` - VPWS + * `vpls` - VPLS + * `vxlan` - VXLAN + * `vxlan-evpn` - VXLAN-EVPN + * `mpls-evpn` - MPLS EVPN + * `pbb-evpn` - PBB EVPN + * `evpn-vpws` - EVPN VPWS + * `epl` - EPL + * `evpl` - EVPL + * `ep-lan` - Ethernet Private LAN + * `evp-lan` - Ethernet Virtual Private LAN + * `ep-tree` - Ethernet Private Tree + * `evp-tree` - Ethernet Virtual Private Tree + * `spb` - SPB + x-spec-enum-id: 0a46f8056d717efc + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefL2VPNTermination: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + l2vpn: + $ref: '#/components/schemas/BriefL2VPN' + required: + - display + - id + - l2vpn + - url + BriefL2VPNTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + l2vpn: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefL2VPNRequest' + required: + - l2vpn + BriefLocation: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + rack_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - id + - name + - rack_count + - slug + - url + BriefLocationRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefMACAddress: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + mac_address: + type: string + description: + type: string + maxLength: 200 + required: + - display + - id + - mac_address + - url + BriefMACAddressRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + mac_address: + type: string + minLength: 1 + description: + type: string + maxLength: 200 + required: + - mac_address + BriefManufacturer: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - slug + - url + BriefManufacturerRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefModule: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module_bay: + $ref: '#/components/schemas/NestedModuleBay' + required: + - device + - display + - id + - module_bay + - url + BriefModuleRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module_bay: + $ref: '#/components/schemas/NestedModuleBayRequest' + required: + - device + - module_bay + BriefModuleType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + profile: + allOf: + - $ref: '#/components/schemas/BriefModuleTypeProfile' + nullable: true + manufacturer: + $ref: '#/components/schemas/BriefManufacturer' + model: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + module_count: + type: integer + readOnly: true + required: + - display + - id + - manufacturer + - model + - module_count + - url + BriefModuleTypeProfile: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefModuleTypeProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefModuleTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - manufacturer + - model + BriefOwner: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefOwnerGroup: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefOwnerGroupRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefOwnerRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefPlatform: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + device_count: + type: integer + readOnly: true + default: 0 + virtualmachine_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - device_count + - display + - id + - name + - slug + - url + - virtualmachine_count + BriefPlatformRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefPowerPanel: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + powerfeed_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - powerfeed_count + - url + BriefPowerPanelRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefPowerPort: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + name: + type: string + maxLength: 64 + description: + type: string + maxLength: 200 + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - device + - display + - id + - name + - url + BriefPowerPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - device + - name + BriefPowerPortTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefPowerPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - name + BriefProvider: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: Full name of the provider + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + circuit_count: + type: integer + format: int64 + readOnly: true + required: + - circuit_count + - display + - id + - name + - slug + - url + BriefProviderAccount: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + default: '' + maxLength: 100 + account: + type: string + title: Account ID + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - account + - display + - id + - url + BriefProviderAccountRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + default: '' + maxLength: 100 + account: + type: string + minLength: 1 + title: Account ID + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - account + BriefProviderNetwork: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefProviderNetworkRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefProviderRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Full name of the provider + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefRIR: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + aggregate_count: + type: integer + format: int64 + readOnly: true + required: + - aggregate_count + - display + - id + - name + - slug + - url + BriefRIRRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefRack: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + device_count: + type: integer + format: int64 + readOnly: true + required: + - device_count + - display + - id + - name + - url + BriefRackGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + rack_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - rack_count + - slug + - url + BriefRackGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefRackRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefRackRole: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + rack_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - rack_count + - slug + - url + BriefRackRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefRackType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + manufacturer: + $ref: '#/components/schemas/BriefManufacturer' + model: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + rack_count: + type: integer + readOnly: true + required: + - display + - id + - manufacturer + - model + - rack_count + - slug + - url + BriefRackTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - manufacturer + - model + - slug + BriefRegion: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + site_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - id + - name + - site_count + - slug + - url + BriefRegionRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefRole: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + prefix_count: + type: integer + format: int64 + readOnly: true + vlan_count: + type: integer + format: int64 + readOnly: true + asn_count: + type: integer + format: int64 + readOnly: true + required: + - asn_count + - display + - id + - name + - prefix_count + - slug + - url + - vlan_count + BriefRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefSite: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: Full name of the site + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - slug + - url + BriefSiteGroup: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + site_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - id + - name + - site_count + - slug + - url + BriefSiteGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefSiteRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Full name of the site + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefTag: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + pattern: ^[-\w]+$ + maxLength: 100 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - slug + - url + BriefTenant: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - slug + - url + BriefTenantGroup: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + tenant_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - id + - name + - slug + - tenant_count + - url + BriefTenantGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefTenantRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefTunnel: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefTunnelGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + tunnel_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - slug + - tunnel_count + - url + BriefTunnelGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefTunnelRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefUser: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + username: + type: string + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + pattern: ^[\w.@+-]+$ + maxLength: 150 + required: + - display + - id + - url + - username + BriefUserRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + username: + type: string + minLength: 1 + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + pattern: ^[\w.@+-]+$ + maxLength: 150 + required: + - username + BriefVLAN: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + - vid + BriefVLANGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + vlan_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - slug + - url + - vlan_count + BriefVLANGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefVLANRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - name + - vid + BriefVLANTranslationPolicy: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefVLANTranslationPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + BriefVRF: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + rd: + type: string + nullable: true + title: Route distinguisher + description: Unique route distinguisher (as defined in RFC 4364) + maxLength: 21 + description: + type: string + maxLength: 200 + prefix_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - prefix_count + - url + BriefVRFRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + rd: + type: string + nullable: true + title: Route distinguisher + description: Unique route distinguisher (as defined in RFC 4364) + maxLength: 21 + description: + type: string + maxLength: 200 + required: + - name + BriefVirtualChassis: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 64 + master: + allOf: + - $ref: '#/components/schemas/NestedDevice' + nullable: true + description: + type: string + maxLength: 200 + member_count: + type: integer + readOnly: true + required: + - display + - id + - member_count + - name + - url + BriefVirtualChassisRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + master: + allOf: + - $ref: '#/components/schemas/NestedDeviceRequest' + nullable: true + description: + type: string + maxLength: 200 + required: + - name + BriefVirtualCircuit: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + cid: + type: string + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider_network: + $ref: '#/components/schemas/BriefProviderNetwork' + description: + type: string + maxLength: 200 + required: + - cid + - display + - id + - provider_network + - url + BriefVirtualCircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider_network: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderNetworkRequest' + description: + type: string + maxLength: 200 + required: + - cid + - provider_network + BriefVirtualCircuitType: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + virtual_circuit_count: + type: integer + format: int64 + readOnly: true + required: + - display + - id + - name + - slug + - url + - virtual_circuit_count + BriefVirtualCircuitTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefVirtualMachine: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + BriefVirtualMachineRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - name + BriefVirtualMachineType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - slug + - url + BriefVirtualMachineTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + BriefWirelessLANGroup: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + wirelesslan_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - id + - name + - slug + - url + - wirelesslan_count + BriefWirelessLANGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + required: + - name + - slug + Cable: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + type: + enum: + - cat3 + - cat5 + - cat5e + - cat6 + - cat6a + - cat7 + - cat7a + - cat8 + - mrj21-trunk + - dac-active + - dac-passive + - coaxial + - rg-6 + - rg-8 + - rg-11 + - rg-59 + - rg-62 + - rg-213 + - lmr-100 + - lmr-200 + - lmr-400 + - mmf + - mmf-om1 + - mmf-om2 + - mmf-om3 + - mmf-om4 + - mmf-om5 + - smf + - smf-os1 + - smf-os2 + - aoc + - power + - usb + - '' + - null + type: string + description: |- + * `cat3` - CAT3 + * `cat5` - CAT5 + * `cat5e` - CAT5e + * `cat6` - CAT6 + * `cat6a` - CAT6a + * `cat7` - CAT7 + * `cat7a` - CAT7a + * `cat8` - CAT8 + * `mrj21-trunk` - MRJ21 Trunk + * `dac-active` - Direct Attach Copper (Active) + * `dac-passive` - Direct Attach Copper (Passive) + * `coaxial` - Coaxial + * `rg-6` - RG-6 + * `rg-8` - RG-8 + * `rg-11` - RG-11 + * `rg-59` - RG-59 + * `rg-62` - RG-62 + * `rg-213` - RG-213 + * `lmr-100` - LMR-100 + * `lmr-200` - LMR-200 + * `lmr-400` - LMR-400 + * `mmf` - Multimode Fiber + * `mmf-om1` - Multimode Fiber (OM1) + * `mmf-om2` - Multimode Fiber (OM2) + * `mmf-om3` - Multimode Fiber (OM3) + * `mmf-om4` - Multimode Fiber (OM4) + * `mmf-om5` - Multimode Fiber (OM5) + * `smf` - Single-mode Fiber + * `smf-os1` - Single-mode Fiber (OS1) + * `smf-os2` - Single-mode Fiber (OS2) + * `aoc` - Active Optical Cabling (AOC) + * `power` - Power + * `usb` - USB + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + a_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObject' + b_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObject' + status: + type: object + properties: + value: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + label: + type: string + enum: + - Connected + - Planned + - Decommissioning + profile: + type: object + properties: + value: + enum: + - single-1c1p + - single-1c2p + - single-1c4p + - single-1c6p + - single-1c8p + - single-1c12p + - single-1c16p + - trunk-2c1p + - trunk-2c2p + - trunk-2c4p + - trunk-2c4p-shuffle + - trunk-2c6p + - trunk-2c8p + - trunk-2c12p + - trunk-4c1p + - trunk-4c2p + - trunk-4c4p + - trunk-4c4p-shuffle + - trunk-4c6p + - trunk-4c8p + - trunk-8c4p + - breakout-1c2p-2c1p + - breakout-1c4p-4c1p + - breakout-1c6p-6c1p + - breakout-2c4p-8c1p-shuffle + type: string + description: |- + * `single-1c1p` - 1C1P + * `single-1c2p` - 1C2P + * `single-1c4p` - 1C4P + * `single-1c6p` - 1C6P + * `single-1c8p` - 1C8P + * `single-1c12p` - 1C12P + * `single-1c16p` - 1C16P + * `trunk-2c1p` - 2C1P trunk + * `trunk-2c2p` - 2C2P trunk + * `trunk-2c4p` - 2C4P trunk + * `trunk-2c4p-shuffle` - 2C4P trunk (shuffle) + * `trunk-2c6p` - 2C6P trunk + * `trunk-2c8p` - 2C8P trunk + * `trunk-2c12p` - 2C12P trunk + * `trunk-4c1p` - 4C1P trunk + * `trunk-4c2p` - 4C2P trunk + * `trunk-4c4p` - 4C4P trunk + * `trunk-4c4p-shuffle` - 4C4P trunk (shuffle) + * `trunk-4c6p` - 4C6P trunk + * `trunk-4c8p` - 4C8P trunk + * `trunk-8c4p` - 8C4P trunk + * `breakout-1c2p-2c1p` - 1C2P:2C1P breakout + * `breakout-1c4p-4c1p` - 1C4P:4C1P breakout + * `breakout-1c6p-6c1p` - 1C6P:6C1P breakout + * `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle) + x-spec-enum-id: f566e6df6572f5d0 + label: + type: string + enum: + - 1C1P + - 1C2P + - 1C4P + - 1C6P + - 1C8P + - 1C12P + - 1C16P + - 2C1P trunk + - 2C2P trunk + - 2C4P trunk + - 2C4P trunk (shuffle) + - 2C6P trunk + - 2C8P trunk + - 2C12P trunk + - 4C1P trunk + - 4C2P trunk + - 4C4P trunk + - 4C4P trunk (shuffle) + - 4C6P trunk + - 4C8P trunk + - 8C4P trunk + - 1C2P:2C1P breakout + - 1C4P:4C1P breakout + - 1C6P:6C1P breakout + - 2C4P:8C1P breakout (shuffle) + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + bundle: + allOf: + - $ref: '#/components/schemas/BriefCableBundle' + nullable: true + label: + type: string + maxLength: 100 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + length: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + length_unit: + type: object + properties: + value: + enum: + - km + - m + - cm + - mi + - ft + - in + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `cm` - Centimeters + * `mi` - Miles + * `ft` - Feet + * `in` - Inches + x-spec-enum-id: 6e7645525ba02462 + label: + type: string + enum: + - Kilometers + - Meters + - Centimeters + - Miles + - Feet + - Inches + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - url + CableBundle: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + cable_count: + type: integer + readOnly: true + default: 0 + required: + - cable_count + - created + - display + - display_url + - id + - last_updated + - name + - url + CableBundleRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + CableRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + type: + enum: + - cat3 + - cat5 + - cat5e + - cat6 + - cat6a + - cat7 + - cat7a + - cat8 + - mrj21-trunk + - dac-active + - dac-passive + - coaxial + - rg-6 + - rg-8 + - rg-11 + - rg-59 + - rg-62 + - rg-213 + - lmr-100 + - lmr-200 + - lmr-400 + - mmf + - mmf-om1 + - mmf-om2 + - mmf-om3 + - mmf-om4 + - mmf-om5 + - smf + - smf-os1 + - smf-os2 + - aoc + - power + - usb + - '' + - null + type: string + description: |- + * `cat3` - CAT3 + * `cat5` - CAT5 + * `cat5e` - CAT5e + * `cat6` - CAT6 + * `cat6a` - CAT6a + * `cat7` - CAT7 + * `cat7a` - CAT7a + * `cat8` - CAT8 + * `mrj21-trunk` - MRJ21 Trunk + * `dac-active` - Direct Attach Copper (Active) + * `dac-passive` - Direct Attach Copper (Passive) + * `coaxial` - Coaxial + * `rg-6` - RG-6 + * `rg-8` - RG-8 + * `rg-11` - RG-11 + * `rg-59` - RG-59 + * `rg-62` - RG-62 + * `rg-213` - RG-213 + * `lmr-100` - LMR-100 + * `lmr-200` - LMR-200 + * `lmr-400` - LMR-400 + * `mmf` - Multimode Fiber + * `mmf-om1` - Multimode Fiber (OM1) + * `mmf-om2` - Multimode Fiber (OM2) + * `mmf-om3` - Multimode Fiber (OM3) + * `mmf-om4` - Multimode Fiber (OM4) + * `mmf-om5` - Multimode Fiber (OM5) + * `smf` - Single-mode Fiber + * `smf-os1` - Single-mode Fiber (OS1) + * `smf-os2` - Single-mode Fiber (OS2) + * `aoc` - Active Optical Cabling (AOC) + * `power` - Power + * `usb` - USB + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + a_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObjectRequest' + b_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObjectRequest' + status: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + profile: + enum: + - single-1c1p + - single-1c2p + - single-1c4p + - single-1c6p + - single-1c8p + - single-1c12p + - single-1c16p + - trunk-2c1p + - trunk-2c2p + - trunk-2c4p + - trunk-2c4p-shuffle + - trunk-2c6p + - trunk-2c8p + - trunk-2c12p + - trunk-4c1p + - trunk-4c2p + - trunk-4c4p + - trunk-4c4p-shuffle + - trunk-4c6p + - trunk-4c8p + - trunk-8c4p + - breakout-1c2p-2c1p + - breakout-1c4p-4c1p + - breakout-1c6p-6c1p + - breakout-2c4p-8c1p-shuffle + type: string + description: |- + * `single-1c1p` - 1C1P + * `single-1c2p` - 1C2P + * `single-1c4p` - 1C4P + * `single-1c6p` - 1C6P + * `single-1c8p` - 1C8P + * `single-1c12p` - 1C12P + * `single-1c16p` - 1C16P + * `trunk-2c1p` - 2C1P trunk + * `trunk-2c2p` - 2C2P trunk + * `trunk-2c4p` - 2C4P trunk + * `trunk-2c4p-shuffle` - 2C4P trunk (shuffle) + * `trunk-2c6p` - 2C6P trunk + * `trunk-2c8p` - 2C8P trunk + * `trunk-2c12p` - 2C12P trunk + * `trunk-4c1p` - 4C1P trunk + * `trunk-4c2p` - 4C2P trunk + * `trunk-4c4p` - 4C4P trunk + * `trunk-4c4p-shuffle` - 4C4P trunk (shuffle) + * `trunk-4c6p` - 4C6P trunk + * `trunk-4c8p` - 4C8P trunk + * `trunk-8c4p` - 8C4P trunk + * `breakout-1c2p-2c1p` - 1C2P:2C1P breakout + * `breakout-1c4p-4c1p` - 1C4P:4C1P breakout + * `breakout-1c6p-6c1p` - 1C6P:6C1P breakout + * `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle) + x-spec-enum-id: f566e6df6572f5d0 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + bundle: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefCableBundleRequest' + nullable: true + nullable: true + label: + type: string + maxLength: 100 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + length: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + length_unit: + enum: + - km + - m + - cm + - mi + - ft + - in + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `cm` - Centimeters + * `mi` - Miles + * `ft` - Feet + * `in` - Inches + x-spec-enum-id: 6e7645525ba02462 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + CableTermination: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + cable: + type: integer + readOnly: true + cable_end: + enum: + - A + - B + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + title: End + termination_type: + type: string + readOnly: true + termination_id: + type: integer + readOnly: true + termination: + readOnly: true + nullable: true + connector: + type: integer + readOnly: true + nullable: true + positions: + type: array + items: + type: integer + maximum: 1024 + minimum: 1 + readOnly: true + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - cable + - cable_end + - connector + - created + - display + - id + - last_updated + - positions + - termination + - termination_id + - termination_type + - url + Circuit: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + cid: + type: string + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider: + $ref: '#/components/schemas/BriefProvider' + provider_account: + allOf: + - $ref: '#/components/schemas/BriefProviderAccount' + nullable: true + type: + $ref: '#/components/schemas/BriefCircuitType' + status: + type: object + properties: + value: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + label: + type: string + enum: + - Planned + - Provisioning + - Active + - Offline + - Deprovisioning + - Decommissioned + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + install_date: + type: string + format: date + nullable: true + title: Installed + termination_date: + type: string + format: date + nullable: true + title: Terminates + commit_rate: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Commit rate (Kbps) + description: Committed rate + description: + type: string + maxLength: 200 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + type: object + properties: + value: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + label: + type: string + enum: + - Kilometers + - Meters + - Miles + - Feet + nullable: true + termination_a: + allOf: + - $ref: '#/components/schemas/CircuitCircuitTermination' + readOnly: true + nullable: true + termination_z: + allOf: + - $ref: '#/components/schemas/CircuitCircuitTermination' + readOnly: true + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + assignments: + type: array + items: + $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_' + required: + - cid + - created + - display + - display_url + - id + - last_updated + - provider + - termination_a + - termination_z + - type + - url + CircuitCircuitTermination: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + termination_type: + type: string + nullable: true + termination_id: + type: integer + nullable: true + termination: + readOnly: true + nullable: true + port_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Port speed (Kbps) + description: Physical circuit speed + upstream_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Upstream speed (Kbps) + description: Upstream speed, if different from port speed + xconnect_id: + type: string + title: Cross-connect ID + description: ID of the local cross-connect + maxLength: 50 + description: + type: string + maxLength: 200 + required: + - display + - display_url + - id + - termination + - url + CircuitCircuitTerminationRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + termination_type: + type: string + nullable: true + termination_id: + type: integer + nullable: true + port_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Port speed (Kbps) + description: Physical circuit speed + upstream_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Upstream speed (Kbps) + description: Upstream speed, if different from port speed + xconnect_id: + type: string + title: Cross-connect ID + description: ID of the local cross-connect + maxLength: 50 + description: + type: string + maxLength: 200 + CircuitGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + circuit_count: + type: integer + format: int64 + readOnly: true + required: + - circuit_count + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + CircuitGroupAssignment: + type: object + description: Base serializer for group assignments under CircuitSerializer. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + group: + $ref: '#/components/schemas/BriefCircuitGroup' + member_type: + type: string + member_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + member: + readOnly: true + nullable: true + priority: + type: object + properties: + value: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + label: + type: string + enum: + - Primary + - Secondary + - Tertiary + - Inactive + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - group + - id + - last_updated + - member + - member_id + - member_type + - url + CircuitGroupAssignmentRequest: + type: object + description: Base serializer for group assignments under CircuitSerializer. + properties: + group: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitGroupRequest' + member_type: + type: string + member_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + priority: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + required: + - group + - member_id + - member_type + CircuitGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + CircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + provider_account: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefProviderAccountRequest' + nullable: true + nullable: true + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitTypeRequest' + status: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + install_date: + type: string + format: date + nullable: true + title: Installed + termination_date: + type: string + format: date + nullable: true + title: Terminates + commit_rate: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Commit rate (Kbps) + description: Committed rate + description: + type: string + maxLength: 200 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + assignments: + type: array + items: + $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request' + required: + - cid + - provider + - type + CircuitTermination: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + circuit: + $ref: '#/components/schemas/BriefCircuit' + term_side: + enum: + - A + - Z + type: string + description: |- + * `A` - A + * `Z` - Z + x-spec-enum-id: 95b8fcc737f355d0 + title: Termination side + termination_type: + type: string + nullable: true + termination_id: + type: integer + nullable: true + termination: + readOnly: true + nullable: true + port_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Port speed (Kbps) + description: Physical circuit speed + upstream_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Upstream speed (Kbps) + description: Upstream speed, if different from port speed + xconnect_id: + type: string + title: Cross-connect ID + description: ID of the local cross-connect + maxLength: 50 + pp_info: + type: string + title: Patch panel/port(s) + description: Patch panel ID and port number(s) + maxLength: 100 + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - circuit + - created + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - term_side + - termination + - url + CircuitTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + circuit: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitRequest' + term_side: + enum: + - A + - Z + type: string + description: |- + * `A` - A + * `Z` - Z + x-spec-enum-id: 95b8fcc737f355d0 + title: Termination side + termination_type: + type: string + nullable: true + termination_id: + type: integer + nullable: true + port_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Port speed (Kbps) + description: Physical circuit speed + upstream_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Upstream speed (Kbps) + description: Upstream speed, if different from port speed + xconnect_id: + type: string + title: Cross-connect ID + description: ID of the local cross-connect + maxLength: 50 + pp_info: + type: string + title: Patch panel/port(s) + description: Patch panel ID and port number(s) + maxLength: 100 + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - circuit + - term_side + CircuitType: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + circuit_count: + type: integer + format: int64 + readOnly: true + required: + - circuit_count + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + CircuitTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + Cluster: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + type: + $ref: '#/components/schemas/BriefClusterType' + group: + allOf: + - $ref: '#/components/schemas/BriefClusterGroup' + nullable: true + status: + type: object + properties: + value: + enum: + - planned + - staging + - active + - decommissioning + - offline + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `offline` - Offline + x-spec-enum-id: 65a25166053759eb + label: + type: string + enum: + - Planned + - Staging + - Active + - Decommissioning + - Offline + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + scope: + readOnly: true + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + device_count: + type: integer + format: int64 + readOnly: true + virtualmachine_count: + type: integer + format: int64 + readOnly: true + allocated_vcpus: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + readOnly: true + allocated_memory: + type: integer + readOnly: true + allocated_disk: + type: integer + readOnly: true + required: + - allocated_disk + - allocated_memory + - allocated_vcpus + - created + - device_count + - display + - display_url + - id + - last_updated + - name + - scope + - type + - url + - virtualmachine_count + ClusterGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + cluster_count: + type: integer + format: int64 + readOnly: true + required: + - cluster_count + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + ClusterGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + ClusterRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefClusterTypeRequest' + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterGroupRequest' + nullable: true + nullable: true + status: + enum: + - planned + - staging + - active + - decommissioning + - offline + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `offline` - Offline + x-spec-enum-id: 65a25166053759eb + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - type + ClusterType: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + cluster_count: + type: integer + format: int64 + readOnly: true + required: + - cluster_count + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + ClusterTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + ConfigContext: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + weight: + type: integer + maximum: 32767 + minimum: 0 + profile: + allOf: + - $ref: '#/components/schemas/BriefConfigContextProfile' + nullable: true + description: + type: string + maxLength: 200 + is_active: + type: boolean + regions: + type: array + items: + $ref: '#/components/schemas/Region' + site_groups: + type: array + items: + $ref: '#/components/schemas/SiteGroup' + sites: + type: array + items: + $ref: '#/components/schemas/Site' + locations: + type: array + items: + $ref: '#/components/schemas/Location' + device_types: + type: array + items: + $ref: '#/components/schemas/DeviceType' + roles: + type: array + items: + $ref: '#/components/schemas/DeviceRole' + platforms: + type: array + items: + $ref: '#/components/schemas/Platform' + cluster_types: + type: array + items: + $ref: '#/components/schemas/ClusterType' + cluster_groups: + type: array + items: + $ref: '#/components/schemas/ClusterGroup' + clusters: + type: array + items: + $ref: '#/components/schemas/Cluster' + tenant_groups: + type: array + items: + $ref: '#/components/schemas/TenantGroup' + tenants: + type: array + items: + $ref: '#/components/schemas/Tenant' + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + type: string + data_source: + $ref: '#/components/schemas/BriefDataSource' + data_path: + type: string + readOnly: true + description: Path to remote file (relative to data source root) + data_file: + $ref: '#/components/schemas/BriefDataFile' + data_synced: + type: string + format: date-time + readOnly: true + nullable: true + title: Date synced + data: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - data + - data_path + - data_synced + - display + - display_url + - id + - last_updated + - name + - url + ConfigContextProfile: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + schema: + nullable: true + description: A JSON schema specifying the structure of the context data + for this profile + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + data_source: + $ref: '#/components/schemas/BriefDataSource' + data_path: + type: string + readOnly: true + description: Path to remote file (relative to data source root) + data_file: + $ref: '#/components/schemas/BriefDataFile' + data_synced: + type: string + format: date-time + readOnly: true + nullable: true + title: Date synced + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - data_path + - data_synced + - display + - display_url + - id + - last_updated + - name + - url + ConfigContextProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + schema: + nullable: true + description: A JSON schema specifying the structure of the context data + for this profile + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + required: + - name + ConfigContextRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + weight: + type: integer + maximum: 32767 + minimum: 0 + profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigContextProfileRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + is_active: + type: boolean + regions: + type: array + items: + type: integer + site_groups: + type: array + items: + type: integer + sites: + type: array + items: + type: integer + locations: + type: array + items: + type: integer + device_types: + type: array + items: + type: integer + roles: + type: array + items: + type: integer + platforms: + type: array + items: + type: integer + cluster_types: + type: array + items: + type: integer + cluster_groups: + type: array + items: + type: integer + clusters: + type: array + items: + type: integer + tenant_groups: + type: array + items: + type: integer + tenants: + type: array + items: + type: integer + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + type: string + minLength: 1 + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + data: {} + required: + - data + - name + ConfigTemplate: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + environment_params: + nullable: true + title: Environment parameters + description: Any additional + parameters to pass when constructing the Jinja environment + template_code: + type: string + description: Jinja template code. + mime_type: + type: string + description: Defaults to text/plain; charset=utf-8 + maxLength: 50 + file_name: + type: string + description: Filename to give to the rendered export file + maxLength: 200 + file_extension: + type: string + description: Extension to append to the rendered filename + maxLength: 15 + as_attachment: + type: boolean + description: Download file as attachment + debug: + type: boolean + description: Enable verbose error output when rendering this template. Not + recommended for production use. + data_source: + $ref: '#/components/schemas/BriefDataSource' + data_path: + type: string + readOnly: true + description: Path to remote file (relative to data source root) + data_file: + $ref: '#/components/schemas/BriefDataFile' + auto_sync_enabled: + type: boolean + description: Enable automatic synchronization of data when the data file + is updated + data_synced: + type: string + format: date-time + readOnly: true + nullable: true + title: Date synced + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - data_path + - data_synced + - display + - display_url + - id + - last_updated + - name + - template_code + - url + ConfigTemplateRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + environment_params: + nullable: true + title: Environment parameters + description: Any additional + parameters to pass when constructing the Jinja environment + template_code: + type: string + minLength: 1 + description: Jinja template code. + mime_type: + type: string + description: Defaults to text/plain; charset=utf-8 + maxLength: 50 + file_name: + type: string + description: Filename to give to the rendered export file + maxLength: 200 + file_extension: + type: string + description: Extension to append to the rendered filename + maxLength: 15 + as_attachment: + type: boolean + description: Download file as attachment + debug: + type: boolean + description: Enable verbose error output when rendering this template. Not + recommended for production use. + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + auto_sync_enabled: + type: boolean + description: Enable automatic synchronization of data when the data file + is updated + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + required: + - name + - template_code + ConsolePort: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + label: + type: string + enum: + - DE-9 + - DB-25 + - RJ-11 + - RJ-12 + - RJ-45 + - Mini-DIN 8 + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + speed: + type: object + properties: + value: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + description: |- + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + x-spec-enum-id: ab6d9635c131a378 + label: + type: string + enum: + - 1200 bps + - 2400 bps + - 4800 bps + - 9600 bps + - 19.2 kbps + - 38.4 kbps + - 57.6 kbps + - 115.2 kbps + nullable: true + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + connected_endpoints: + type: array + items: {} + nullable: true + readOnly: true + connected_endpoints_type: + type: string + readOnly: true + nullable: true + connected_endpoints_reachable: + type: boolean + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - connected_endpoints + - connected_endpoints_reachable + - connected_endpoints_type + - created + - device + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - name + - url + ConsolePortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + speed: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + description: |- + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + x-spec-enum-id: ab6d9635c131a378 + nullable: true + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + ConsolePortTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + label: + type: string + enum: + - DE-9 + - DB-25 + - RJ-11 + - RJ-12 + - RJ-45 + - Mini-DIN 8 + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - url + ConsolePortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + description: + type: string + maxLength: 200 + required: + - name + ConsoleServerPort: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + label: + type: string + enum: + - DE-9 + - DB-25 + - RJ-11 + - RJ-12 + - RJ-45 + - Mini-DIN 8 + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + speed: + type: object + properties: + value: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + description: |- + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + x-spec-enum-id: ab6d9635c131a378 + label: + type: string + enum: + - 1200 bps + - 2400 bps + - 4800 bps + - 9600 bps + - 19.2 kbps + - 38.4 kbps + - 57.6 kbps + - 115.2 kbps + nullable: true + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + connected_endpoints: + type: array + items: {} + nullable: true + readOnly: true + connected_endpoints_type: + type: string + readOnly: true + nullable: true + connected_endpoints_reachable: + type: boolean + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - connected_endpoints + - connected_endpoints_reachable + - connected_endpoints_type + - created + - device + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - name + - url + ConsoleServerPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + speed: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + description: |- + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + x-spec-enum-id: ab6d9635c131a378 + nullable: true + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + ConsoleServerPortTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + label: + type: string + enum: + - DE-9 + - DB-25 + - RJ-11 + - RJ-12 + - RJ-45 + - Mini-DIN 8 + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - url + ConsoleServerPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + description: + type: string + maxLength: 200 + required: + - name + Contact: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + groups: + type: array + items: + $ref: '#/components/schemas/ContactGroup' + name: + type: string + maxLength: 100 + title: + type: string + maxLength: 100 + phone: + type: string + maxLength: 50 + email: + type: string + format: email + maxLength: 254 + address: + type: string + maxLength: 200 + link: + type: string + format: uri + maxLength: 200 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - url + ContactAssignment: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + object: + readOnly: true + nullable: true + contact: + $ref: '#/components/schemas/BriefContact' + role: + allOf: + - $ref: '#/components/schemas/BriefContactRole' + nullable: true + priority: + type: object + properties: + value: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + label: + type: string + enum: + - Primary + - Secondary + - Tertiary + - Inactive + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - contact + - created + - display + - id + - last_updated + - object + - object_id + - object_type + - url + ContactAssignmentRequest: + type: object + description: Adds support for custom fields and tags. + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + contact: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefContactRequest' + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefContactRoleRequest' + nullable: true + nullable: true + priority: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - contact + - object_id + - object_type + ContactGroup: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedContactGroup' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + contact_count: + type: integer + readOnly: true + default: 0 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - contact_count + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + ContactGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedContactGroupRequest' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + ContactRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + groups: + type: array + items: + type: integer + name: + type: string + minLength: 1 + maxLength: 100 + title: + type: string + maxLength: 100 + phone: + type: string + maxLength: 50 + email: + type: string + format: email + maxLength: 254 + address: + type: string + maxLength: 200 + link: + type: string + format: uri + maxLength: 200 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + ContactRole: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + ContactRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + CreateAvailableVLANRequest: + type: object + description: Adds support for custom fields and tags. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + site: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + x-spec-enum-id: ca933c38b935e547 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + CustomField: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_types: + type: array + items: + type: string + type: + type: object + properties: + value: + enum: + - text + - longtext + - integer + - decimal + - boolean + - date + - datetime + - url + - json + - select + - multiselect + - object + - multiobject + type: string + description: |- + * `text` - Text + * `longtext` - Text (long) + * `integer` - Integer + * `decimal` - Decimal + * `boolean` - Boolean (true/false) + * `date` - Date + * `datetime` - Date & time + * `url` - URL + * `json` - JSON + * `select` - Selection + * `multiselect` - Multiple selection + * `object` - Object + * `multiobject` - Multiple objects + x-spec-enum-id: 47c52a3d983e924c + label: + type: string + enum: + - Text + - Text (long) + - Integer + - Decimal + - Boolean (true/false) + - Date + - Date & time + - URL + - JSON + - Selection + - Multiple selection + - Object + - Multiple objects + related_object_type: + type: string + nullable: true + data_type: + type: string + readOnly: true + name: + type: string + description: Internal field name + pattern: ^[a-z0-9_]+$ + maxLength: 50 + label: + type: string + description: Name of the field as displayed to users (if not provided, 'the + field's name will be used) + maxLength: 50 + group_name: + type: string + description: Custom fields within the same group will be displayed together + maxLength: 50 + description: + type: string + maxLength: 200 + required: + type: boolean + description: This field is required when creating new objects or editing + an existing object. + unique: + type: boolean + title: Must be unique + description: The value of this field must be unique for the assigned object + search_weight: + type: integer + maximum: 32767 + minimum: 0 + description: Weighting for search. Lower values are considered more important. + Fields with a search weight of zero will be ignored. + filter_logic: + type: object + properties: + value: + enum: + - disabled + - loose + - exact + type: string + description: |- + * `disabled` - Disabled + * `loose` - Loose + * `exact` - Exact + x-spec-enum-id: d168820c798ae45a + label: + type: string + enum: + - Disabled + - Loose + - Exact + ui_visible: + type: object + properties: + value: + enum: + - always + - if-set + - hidden + type: string + description: |- + * `always` - Always + * `if-set` - If set + * `hidden` - Hidden + x-spec-enum-id: f32800c399b927b6 + label: + type: string + enum: + - Always + - If set + - Hidden + ui_editable: + type: object + properties: + value: + enum: + - 'yes' + - 'no' + - hidden + type: string + description: |- + * `yes` - Yes + * `no` - No + * `hidden` - Hidden + x-spec-enum-id: 336f52760e62022f + label: + type: string + enum: + - 'Yes' + - 'No' + - Hidden + is_cloneable: + type: boolean + description: Replicate this value when cloning objects + default: + nullable: true + description: Default value for the field (must be a JSON value). Encapsulate + strings with double quotes (e.g. "Foo"). + related_object_filter: + nullable: true + description: Filter the object selection choices using a query_params dict + (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo"). + weight: + type: integer + maximum: 32767 + minimum: 0 + title: Display weight + description: Fields with higher weights appear lower in a form. + validation_minimum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Minimum value + description: Minimum allowed value (for numeric fields) + validation_maximum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Maximum value + description: Maximum allowed value (for numeric fields) + validation_regex: + type: string + description: Regular expression to enforce on text field values. Use ^ and + $ to force matching of entire string. For example, ^[A-Z]{3}$ + will limit values to exactly three uppercase letters. + maxLength: 500 + validation_schema: + nullable: true + description: A JSON schema definition for validating the custom field value + choice_set: + allOf: + - $ref: '#/components/schemas/BriefCustomFieldChoiceSet' + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - data_type + - display + - display_url + - id + - last_updated + - name + - object_types + - type + - url + CustomFieldChoiceSet: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + base_choices: + type: object + properties: + value: + enum: + - IATA + - ISO_3166 + - UN_LOCODE + type: string + description: |- + * `IATA` - IATA (Airport codes) + * `ISO_3166` - ISO 3166 (Country codes) + * `UN_LOCODE` - UN/LOCODE (Location codes) + x-spec-enum-id: cf0efb5195f85007 + label: + type: string + enum: + - IATA (Airport codes) + - ISO 3166 (Country codes) + - UN/LOCODE (Location codes) + extra_choices: + type: array + items: + type: array + items: {} + maxItems: 2 + minItems: 2 + choice_colors: + type: object + additionalProperties: + enum: + - blue + - indigo + - purple + - pink + - red + - orange + - yellow + - green + - teal + - cyan + - gray + - black + - white + type: string + description: |- + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + x-spec-enum-id: de0a6a124020dfe0 + order_alphabetically: + type: boolean + description: Choices are automatically ordered alphabetically + choices_count: + type: integer + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - choices_count + - created + - display + - display_url + - extra_choices + - id + - last_updated + - name + - url + CustomFieldChoiceSetRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + base_choices: + enum: + - IATA + - ISO_3166 + - UN_LOCODE + type: string + description: |- + * `IATA` - IATA (Airport codes) + * `ISO_3166` - ISO 3166 (Country codes) + * `UN_LOCODE` - UN/LOCODE (Location codes) + x-spec-enum-id: cf0efb5195f85007 + extra_choices: + type: array + items: + type: array + items: {} + maxItems: 2 + minItems: 2 + choice_colors: + type: object + additionalProperties: + enum: + - blue + - indigo + - purple + - pink + - red + - orange + - yellow + - green + - teal + - cyan + - gray + - black + - white + type: string + description: |- + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + x-spec-enum-id: de0a6a124020dfe0 + order_alphabetically: + type: boolean + description: Choices are automatically ordered alphabetically + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + required: + - extra_choices + - name + CustomFieldRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + type: + enum: + - text + - longtext + - integer + - decimal + - boolean + - date + - datetime + - url + - json + - select + - multiselect + - object + - multiobject + type: string + description: |- + * `text` - Text + * `longtext` - Text (long) + * `integer` - Integer + * `decimal` - Decimal + * `boolean` - Boolean (true/false) + * `date` - Date + * `datetime` - Date & time + * `url` - URL + * `json` - JSON + * `select` - Selection + * `multiselect` - Multiple selection + * `object` - Object + * `multiobject` - Multiple objects + x-spec-enum-id: 47c52a3d983e924c + related_object_type: + type: string + nullable: true + name: + type: string + minLength: 1 + description: Internal field name + pattern: ^[a-z0-9_]+$ + maxLength: 50 + label: + type: string + description: Name of the field as displayed to users (if not provided, 'the + field's name will be used) + maxLength: 50 + group_name: + type: string + description: Custom fields within the same group will be displayed together + maxLength: 50 + description: + type: string + maxLength: 200 + required: + type: boolean + description: This field is required when creating new objects or editing + an existing object. + unique: + type: boolean + title: Must be unique + description: The value of this field must be unique for the assigned object + search_weight: + type: integer + maximum: 32767 + minimum: 0 + description: Weighting for search. Lower values are considered more important. + Fields with a search weight of zero will be ignored. + filter_logic: + enum: + - disabled + - loose + - exact + type: string + description: |- + * `disabled` - Disabled + * `loose` - Loose + * `exact` - Exact + x-spec-enum-id: d168820c798ae45a + ui_visible: + enum: + - always + - if-set + - hidden + type: string + description: |- + * `always` - Always + * `if-set` - If set + * `hidden` - Hidden + x-spec-enum-id: f32800c399b927b6 + ui_editable: + enum: + - 'yes' + - 'no' + - hidden + type: string + description: |- + * `yes` - Yes + * `no` - No + * `hidden` - Hidden + x-spec-enum-id: 336f52760e62022f + is_cloneable: + type: boolean + description: Replicate this value when cloning objects + default: + nullable: true + description: Default value for the field (must be a JSON value). Encapsulate + strings with double quotes (e.g. "Foo"). + related_object_filter: + nullable: true + description: Filter the object selection choices using a query_params dict + (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo"). + weight: + type: integer + maximum: 32767 + minimum: 0 + title: Display weight + description: Fields with higher weights appear lower in a form. + validation_minimum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Minimum value + description: Minimum allowed value (for numeric fields) + validation_maximum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Maximum value + description: Maximum allowed value (for numeric fields) + validation_regex: + type: string + description: Regular expression to enforce on text field values. Use ^ and + $ to force matching of entire string. For example, ^[A-Z]{3}$ + will limit values to exactly three uppercase letters. + maxLength: 500 + validation_schema: + nullable: true + description: A JSON schema definition for validating the custom field value + choice_set: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefCustomFieldChoiceSetRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - object_types + - type + CustomLink: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_types: + type: array + items: + type: string + name: + type: string + maxLength: 100 + enabled: + type: boolean + link_text: + type: string + description: Jinja2 template code for link text + link_url: + type: string + description: Jinja2 template code for link URL + weight: + type: integer + maximum: 32767 + minimum: 0 + group_name: + type: string + description: Links with the same group will appear as a dropdown menu + maxLength: 50 + button_class: + enum: + - default + - blue + - indigo + - purple + - pink + - red + - orange + - yellow + - green + - teal + - cyan + - gray + - black + - white + - ghost-dark + type: string + x-spec-enum-id: 5e54b3bd086685ce + description: |- + The class of the first link in a group will be used for the dropdown button + + * `default` - Default + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + * `ghost-dark` - Link + new_window: + type: boolean + description: Force link to open in a new window + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - link_text + - link_url + - name + - object_types + - url + CustomLinkRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 100 + enabled: + type: boolean + link_text: + type: string + minLength: 1 + description: Jinja2 template code for link text + link_url: + type: string + minLength: 1 + description: Jinja2 template code for link URL + weight: + type: integer + maximum: 32767 + minimum: 0 + group_name: + type: string + description: Links with the same group will appear as a dropdown menu + maxLength: 50 + button_class: + enum: + - default + - blue + - indigo + - purple + - pink + - red + - orange + - yellow + - green + - teal + - cyan + - gray + - black + - white + - ghost-dark + type: string + x-spec-enum-id: 5e54b3bd086685ce + description: |- + The class of the first link in a group will be used for the dropdown button + + * `default` - Default + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + * `ghost-dark` - Link + new_window: + type: boolean + description: Force link to open in a new window + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + required: + - link_text + - link_url + - name + - object_types + Dashboard: + type: object + properties: + layout: {} + config: {} + DashboardRequest: + type: object + properties: + layout: {} + config: {} + DataFile: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + source: + allOf: + - $ref: '#/components/schemas/BriefDataSource' + readOnly: true + path: + type: string + readOnly: true + description: File path relative to the data source's root + last_updated: + type: string + format: date-time + readOnly: true + size: + type: integer + readOnly: true + hash: + type: string + readOnly: true + description: SHA256 hash of the file data + required: + - display + - display_url + - hash + - id + - last_updated + - path + - size + - source + - url + DataSource: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + type: + type: object + properties: + value: + enum: + - null + - local + - git + - amazon-s3 + description: |- + * `None` - --------- + * `local` - Local + * `git` - Git + * `amazon-s3` - Amazon S3 + x-spec-enum-id: 562b613a749b34b0 + label: + type: string + enum: + - '---------' + - Local + - Git + - Amazon S3 + source_url: + type: string + title: URL + maxLength: 200 + enabled: + type: boolean + status: + type: object + properties: + value: + enum: + - new + - queued + - syncing + - completed + - failed + type: string + description: |- + * `new` - New + * `queued` - Queued + * `syncing` - Syncing + * `completed` - Completed + * `failed` - Failed + x-spec-enum-id: 97ed937d7f0040be + label: + type: string + enum: + - New + - Queued + - Syncing + - Completed + - Failed + readOnly: true + description: + type: string + maxLength: 200 + sync_interval: + enum: + - 1 + - 60 + - 720 + - 1440 + - 10080 + - 43200 + - null + type: integer + description: |- + * `1` - Minutely + * `60` - Hourly + * `720` - 12 hours + * `1440` - Daily + * `10080` - Weekly + * `43200` - 30 days + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + minimum: 0 + maximum: 32767 + parameters: + nullable: true + ignore_rules: + type: string + description: Patterns (one per line) matching files or paths to ignore when + syncing + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + last_synced: + type: string + format: date-time + readOnly: true + nullable: true + file_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - file_count + - id + - last_synced + - last_updated + - name + - source_url + - status + - type + - url + DataSourceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + type: + enum: + - null + - local + - git + - amazon-s3 + description: |- + * `None` - --------- + * `local` - Local + * `git` - Git + * `amazon-s3` - Amazon S3 + x-spec-enum-id: 562b613a749b34b0 + source_url: + type: string + minLength: 1 + title: URL + maxLength: 200 + enabled: + type: boolean + description: + type: string + maxLength: 200 + sync_interval: + enum: + - 1 + - 60 + - 720 + - 1440 + - 10080 + - 43200 + - null + type: integer + description: |- + * `1` - Minutely + * `60` - Hourly + * `720` - 12 hours + * `1440` - Daily + * `10080` - Weekly + * `43200` - 30 days + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + minimum: 0 + maximum: 32767 + parameters: + nullable: true + ignore_rules: + type: string + description: Patterns (one per line) matching files or paths to ignore when + syncing + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + custom_fields: + type: object + additionalProperties: {} + required: + - name + - source_url + - type + Device: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + nullable: true + maxLength: 64 + device_type: + $ref: '#/components/schemas/BriefDeviceType' + role: + $ref: '#/components/schemas/BriefDeviceRole' + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + platform: + allOf: + - $ref: '#/components/schemas/BriefPlatform' + nullable: true + serial: + type: string + title: Serial number + description: Chassis serial number, assigned by the manufacturer + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + site: + $ref: '#/components/schemas/BriefSite' + location: + allOf: + - $ref: '#/components/schemas/BriefLocation' + nullable: true + rack: + allOf: + - $ref: '#/components/schemas/BriefRack' + nullable: true + position: + type: number + format: double + maximum: 1000 + minimum: 0.5 + exclusiveMaximum: true + nullable: true + title: Position (U) + face: + type: object + properties: + value: + enum: + - front + - rear + - '' + type: string + description: |- + * `front` - Front + * `rear` - Rear + x-spec-enum-id: d2fb9b3f75158b83 + label: + type: string + enum: + - Front + - Rear + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + parent_device: + allOf: + - $ref: '#/components/schemas/NestedDevice' + nullable: true + readOnly: true + status: + type: object + properties: + value: + enum: + - offline + - active + - planned + - staged + - failed + - inventory + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `inventory` - Inventory + * `decommissioning` - Decommissioning + x-spec-enum-id: 65feb4244cc9110c + label: + type: string + enum: + - Offline + - Active + - Planned + - Staged + - Failed + - Inventory + - Decommissioning + airflow: + type: object + properties: + value: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + label: + type: string + enum: + - Front to rear + - Rear to front + - Left to right + - Right to left + - Side to rear + - Rear to side + - Bottom to top + - Top to bottom + - Passive + - Mixed + primary_ip: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + readOnly: true + nullable: true + primary_ip4: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + primary_ip6: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + oob_ip: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + cluster: + allOf: + - $ref: '#/components/schemas/BriefCluster' + nullable: true + virtual_chassis: + allOf: + - $ref: '#/components/schemas/BriefVirtualChassis' + nullable: true + vc_position: + type: integer + maximum: 255 + minimum: 0 + nullable: true + vc_priority: + type: integer + maximum: 255 + minimum: 0 + nullable: true + description: Virtual chassis master election priority + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + config_template: + allOf: + - $ref: '#/components/schemas/BriefConfigTemplate' + nullable: true + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + console_port_count: + type: integer + readOnly: true + console_server_port_count: + type: integer + readOnly: true + power_port_count: + type: integer + readOnly: true + power_outlet_count: + type: integer + readOnly: true + interface_count: + type: integer + readOnly: true + front_port_count: + type: integer + readOnly: true + rear_port_count: + type: integer + readOnly: true + device_bay_count: + type: integer + readOnly: true + module_bay_count: + type: integer + readOnly: true + inventory_item_count: + type: integer + readOnly: true + required: + - console_port_count + - console_server_port_count + - created + - device_bay_count + - device_type + - display + - display_url + - front_port_count + - id + - interface_count + - inventory_item_count + - last_updated + - module_bay_count + - parent_device + - power_outlet_count + - power_port_count + - primary_ip + - rear_port_count + - role + - site + - url + DeviceBay: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + enabled: + type: boolean + description: + type: string + maxLength: 200 + installed_device: + allOf: + - $ref: '#/components/schemas/BriefDevice' + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - created + - device + - display + - display_url + - id + - last_updated + - name + - url + DeviceBayRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + enabled: + type: boolean + description: + type: string + maxLength: 200 + installed_device: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + DeviceBayTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + $ref: '#/components/schemas/BriefDeviceType' + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + enabled: + type: boolean + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - device_type + - display + - id + - last_updated + - name + - url + DeviceBayTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + enabled: + type: boolean + description: + type: string + maxLength: 200 + required: + - device_type + - name + DeviceRole: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + vm_role: + type: boolean + description: Virtual machines may be assigned to this role + config_template: + allOf: + - $ref: '#/components/schemas/BriefConfigTemplate' + nullable: true + parent: + allOf: + - $ref: '#/components/schemas/NestedDeviceRole' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + device_count: + type: integer + readOnly: true + default: 0 + virtualmachine_count: + type: integer + readOnly: true + default: 0 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - created + - device_count + - display + - display_url + - id + - last_updated + - name + - slug + - url + - virtualmachine_count + DeviceRoleRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + vm_role: + type: boolean + description: Virtual machines may be assigned to this role + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + parent: + allOf: + - $ref: '#/components/schemas/NestedDeviceRoleRequest' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + DeviceType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + manufacturer: + $ref: '#/components/schemas/BriefManufacturer' + default_platform: + allOf: + - $ref: '#/components/schemas/BriefPlatform' + nullable: true + model: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + u_height: + type: number + format: double + maximum: 1000 + minimum: 0 + exclusiveMaximum: true + default: 1.0 + title: Position (U) + exclude_from_utilization: + type: boolean + description: Devices of this type are excluded when calculating rack utilization. + is_full_depth: + type: boolean + description: Device consumes both front and rear rack faces. + subdevice_role: + type: object + properties: + value: + enum: + - parent + - child + - '' + - null + type: string + description: |- + * `parent` - Parent + * `child` - Child + x-spec-enum-id: 65a61d5e1deb4a24 + label: + type: string + enum: + - Parent + - Child + nullable: true + airflow: + type: object + properties: + value: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + label: + type: string + enum: + - Front to rear + - Rear to front + - Left to right + - Right to left + - Side to rear + - Rear to side + - Bottom to top + - Top to bottom + - Passive + - Mixed + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + type: object + properties: + value: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + label: + type: string + enum: + - Kilograms + - Grams + - Pounds + - Ounces + nullable: true + front_image: + type: string + format: uri + nullable: true + rear_image: + type: string + format: uri + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + device_count: + type: integer + readOnly: true + console_port_template_count: + type: integer + readOnly: true + console_server_port_template_count: + type: integer + readOnly: true + power_port_template_count: + type: integer + readOnly: true + power_outlet_template_count: + type: integer + readOnly: true + interface_template_count: + type: integer + readOnly: true + front_port_template_count: + type: integer + readOnly: true + rear_port_template_count: + type: integer + readOnly: true + device_bay_template_count: + type: integer + readOnly: true + module_bay_template_count: + type: integer + readOnly: true + inventory_item_template_count: + type: integer + readOnly: true + required: + - console_port_template_count + - console_server_port_template_count + - created + - device_bay_template_count + - device_count + - display + - display_url + - front_port_template_count + - id + - interface_template_count + - inventory_item_template_count + - last_updated + - manufacturer + - model + - module_bay_template_count + - power_outlet_template_count + - power_port_template_count + - rear_port_template_count + - slug + - url + DeviceTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + default_platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + u_height: + type: number + format: double + maximum: 1000 + minimum: 0 + exclusiveMaximum: true + default: 1.0 + title: Position (U) + exclude_from_utilization: + type: boolean + description: Devices of this type are excluded when calculating rack utilization. + is_full_depth: + type: boolean + description: Device consumes both front and rear rack faces. + subdevice_role: + enum: + - parent + - child + - '' + - null + type: string + description: |- + * `parent` - Parent + * `child` - Child + x-spec-enum-id: 65a61d5e1deb4a24 + nullable: true + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + front_image: + type: string + format: binary + nullable: true + rear_image: + type: string + format: binary + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - manufacturer + - model + - slug + DeviceWithConfigContext: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + nullable: true + maxLength: 64 + device_type: + $ref: '#/components/schemas/BriefDeviceType' + role: + $ref: '#/components/schemas/BriefDeviceRole' + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + platform: + allOf: + - $ref: '#/components/schemas/BriefPlatform' + nullable: true + serial: + type: string + title: Serial number + description: Chassis serial number, assigned by the manufacturer + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + site: + $ref: '#/components/schemas/BriefSite' + location: + allOf: + - $ref: '#/components/schemas/BriefLocation' + nullable: true + rack: + allOf: + - $ref: '#/components/schemas/BriefRack' + nullable: true + position: + type: number + format: double + maximum: 1000 + minimum: 0.5 + exclusiveMaximum: true + nullable: true + title: Position (U) + face: + type: object + properties: + value: + enum: + - front + - rear + - '' + type: string + description: |- + * `front` - Front + * `rear` - Rear + x-spec-enum-id: d2fb9b3f75158b83 + label: + type: string + enum: + - Front + - Rear + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + parent_device: + allOf: + - $ref: '#/components/schemas/NestedDevice' + nullable: true + readOnly: true + status: + type: object + properties: + value: + enum: + - offline + - active + - planned + - staged + - failed + - inventory + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `inventory` - Inventory + * `decommissioning` - Decommissioning + x-spec-enum-id: 65feb4244cc9110c + label: + type: string + enum: + - Offline + - Active + - Planned + - Staged + - Failed + - Inventory + - Decommissioning + airflow: + type: object + properties: + value: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + label: + type: string + enum: + - Front to rear + - Rear to front + - Left to right + - Right to left + - Side to rear + - Rear to side + - Bottom to top + - Top to bottom + - Passive + - Mixed + primary_ip: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + readOnly: true + nullable: true + primary_ip4: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + primary_ip6: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + oob_ip: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + cluster: + allOf: + - $ref: '#/components/schemas/BriefCluster' + nullable: true + virtual_chassis: + allOf: + - $ref: '#/components/schemas/BriefVirtualChassis' + nullable: true + vc_position: + type: integer + maximum: 255 + minimum: 0 + nullable: true + vc_priority: + type: integer + maximum: 255 + minimum: 0 + nullable: true + description: Virtual chassis master election priority + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + config_template: + allOf: + - $ref: '#/components/schemas/BriefConfigTemplate' + nullable: true + config_context: + nullable: true + readOnly: true + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + console_port_count: + type: integer + readOnly: true + console_server_port_count: + type: integer + readOnly: true + power_port_count: + type: integer + readOnly: true + power_outlet_count: + type: integer + readOnly: true + interface_count: + type: integer + readOnly: true + front_port_count: + type: integer + readOnly: true + rear_port_count: + type: integer + readOnly: true + device_bay_count: + type: integer + readOnly: true + module_bay_count: + type: integer + readOnly: true + inventory_item_count: + type: integer + readOnly: true + required: + - config_context + - console_port_count + - console_server_port_count + - created + - device_bay_count + - device_type + - display + - display_url + - front_port_count + - id + - interface_count + - inventory_item_count + - last_updated + - module_bay_count + - parent_device + - power_outlet_count + - power_port_count + - primary_ip + - rear_port_count + - role + - site + - url + DeviceWithConfigContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + nullable: true + maxLength: 64 + device_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + role: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRoleRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + serial: + type: string + title: Serial number + description: Chassis serial number, assigned by the manufacturer + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + rack: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRequest' + nullable: true + nullable: true + position: + type: number + format: double + maximum: 1000 + minimum: 0.5 + exclusiveMaximum: true + nullable: true + title: Position (U) + face: + enum: + - front + - rear + - '' + type: string + description: |- + * `front` - Front + * `rear` - Rear + x-spec-enum-id: d2fb9b3f75158b83 + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + status: + enum: + - offline + - active + - planned + - staged + - failed + - inventory + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `inventory` - Inventory + * `decommissioning` - Decommissioning + x-spec-enum-id: 65feb4244cc9110c + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + oob_ip: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + cluster: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterRequest' + nullable: true + nullable: true + virtual_chassis: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVirtualChassisRequest' + nullable: true + nullable: true + vc_position: + type: integer + maximum: 255 + minimum: 0 + nullable: true + vc_priority: + type: integer + maximum: 255 + minimum: 0 + nullable: true + description: Virtual chassis master election priority + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device_type + - role + - site + EventRule: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_types: + type: array + items: + type: string + name: + type: string + maxLength: 150 + enabled: + type: boolean + event_types: + type: array + items: + enum: + - object_created + - object_updated + - object_deleted + - job_started + - job_completed + - job_failed + - job_errored + type: string + description: |- + * `object_created` - Object created + * `object_updated` - Object updated + * `object_deleted` - Object deleted + * `job_started` - Job started + * `job_completed` - Job completed + * `job_failed` - Job failed + * `job_errored` - Job errored + x-spec-enum-id: 01e557313a5c7bd2 + description: The types of event which will trigger this rule. + conditions: + nullable: true + description: A set of conditions which determine whether the event will + be generated. + action_type: + type: object + properties: + value: + enum: + - webhook + - script + - notification + type: string + description: |- + * `webhook` - Webhook + * `script` - Script + * `notification` - Notification + x-spec-enum-id: 287901b937995956 + label: + type: string + enum: + - Webhook + - Script + - Notification + action_object_type: + type: string + action_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + action_object: + readOnly: true + nullable: true + description: + type: string + maxLength: 200 + custom_fields: + type: object + additionalProperties: {} + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - action_object + - action_object_type + - action_type + - created + - display + - display_url + - event_types + - id + - last_updated + - name + - object_types + - url + EventRuleRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 150 + enabled: + type: boolean + event_types: + type: array + items: + enum: + - object_created + - object_updated + - object_deleted + - job_started + - job_completed + - job_failed + - job_errored + type: string + description: |- + * `object_created` - Object created + * `object_updated` - Object updated + * `object_deleted` - Object deleted + * `job_started` - Job started + * `job_completed` - Job completed + * `job_failed` - Job failed + * `job_errored` - Job errored + x-spec-enum-id: 01e557313a5c7bd2 + description: The types of event which will trigger this rule. + conditions: + nullable: true + description: A set of conditions which determine whether the event will + be generated. + action_type: + enum: + - webhook + - script + - notification + type: string + description: |- + * `webhook` - Webhook + * `script` - Script + * `notification` - Notification + x-spec-enum-id: 287901b937995956 + action_object_type: + type: string + action_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + required: + - action_object_type + - action_type + - event_types + - name + - object_types + ExportTemplate: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_types: + type: array + items: + type: string + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + environment_params: + nullable: true + title: Environment parameters + description: Any additional + parameters to pass when constructing the Jinja environment + template_code: + type: string + description: Jinja template code. + mime_type: + type: string + description: Defaults to text/plain; charset=utf-8 + maxLength: 50 + file_name: + type: string + description: Filename to give to the rendered export file + maxLength: 200 + file_extension: + type: string + description: Extension to append to the rendered filename + maxLength: 15 + as_attachment: + type: boolean + description: Download file as attachment + data_source: + $ref: '#/components/schemas/BriefDataSource' + data_path: + type: string + readOnly: true + description: Path to remote file (relative to data source root) + data_file: + allOf: + - $ref: '#/components/schemas/BriefDataFile' + readOnly: true + data_synced: + type: string + format: date-time + readOnly: true + nullable: true + title: Date synced + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - data_file + - data_path + - data_synced + - display + - display_url + - id + - last_updated + - name + - object_types + - template_code + - url + ExportTemplateRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + environment_params: + nullable: true + title: Environment parameters + description: Any additional + parameters to pass when constructing the Jinja environment + template_code: + type: string + minLength: 1 + description: Jinja template code. + mime_type: + type: string + description: Defaults to text/plain; charset=utf-8 + maxLength: 50 + file_name: + type: string + description: Filename to give to the rendered export file + maxLength: 200 + file_extension: + type: string + description: Extension to append to the rendered filename + maxLength: 15 + as_attachment: + type: boolean + description: Download file as attachment + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + required: + - name + - object_types + - template_code + FHRPGroup: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 100 + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + protocol: + enum: + - vrrp2 + - vrrp3 + - carp + - clusterxl + - hsrp + - glbp + - other + type: string + description: |- + * `vrrp2` - VRRPv2 + * `vrrp3` - VRRPv3 + * `carp` - CARP + * `clusterxl` - ClusterXL + * `hsrp` - HSRP + * `glbp` - GLBP + * `other` - Other + x-spec-enum-id: 98de93c9f65d1c65 + group_id: + type: integer + maximum: 32767 + minimum: 0 + auth_type: + enum: + - plaintext + - md5 + - '' + - null + type: string + description: |- + * `plaintext` - Plaintext + * `md5` - MD5 + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + auth_key: + type: string + title: Authentication key + maxLength: 255 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + ip_addresses: + type: array + items: + $ref: '#/components/schemas/BriefIPAddress' + readOnly: true + required: + - created + - display + - display_url + - group_id + - id + - ip_addresses + - last_updated + - protocol + - url + FHRPGroupAssignment: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + group: + $ref: '#/components/schemas/BriefFHRPGroup' + interface_type: + type: string + interface_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + interface: + readOnly: true + nullable: true + priority: + type: integer + maximum: 255 + minimum: 0 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - group + - id + - interface + - interface_id + - interface_type + - last_updated + - priority + - url + FHRPGroupAssignmentRequest: + type: object + description: Adds support for custom fields and tags. + properties: + group: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefFHRPGroupRequest' + interface_type: + type: string + interface_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + priority: + type: integer + maximum: 255 + minimum: 0 + required: + - group + - interface_id + - interface_type + - priority + FHRPGroupRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + maxLength: 100 + protocol: + enum: + - vrrp2 + - vrrp3 + - carp + - clusterxl + - hsrp + - glbp + - other + type: string + description: |- + * `vrrp2` - VRRPv2 + * `vrrp3` - VRRPv3 + * `carp` - CARP + * `clusterxl` - ClusterXL + * `hsrp` - HSRP + * `glbp` - GLBP + * `other` - Other + x-spec-enum-id: 98de93c9f65d1c65 + group_id: + type: integer + maximum: 32767 + minimum: 0 + auth_type: + enum: + - plaintext + - md5 + - '' + - null + type: string + description: |- + * `plaintext` - Plaintext + * `md5` - MD5 + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + auth_key: + type: string + title: Authentication key + maxLength: 255 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - group_id + - protocol + FrontPort: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + label: + type: string + enum: + - 8P8C + - 8P6C + - 8P4C + - 8P2C + - 6P6C + - 6P4C + - 6P2C + - 4P4C + - 4P2C + - GG45 + - TERA 4P + - TERA 2P + - TERA 1P + - 110 Punch + - BNC + - F Connector + - N Connector + - MRJ21 + - FC + - FC/PC + - FC/UPC + - FC/APC + - LC + - LC/PC + - LC/UPC + - LC/APC + - LSH + - LSH/PC + - LSH/UPC + - LSH/APC + - LX.5 + - LX.5/PC + - LX.5/UPC + - LX.5/APC + - MPO + - MTRJ + - SC + - SC/PC + - SC/UPC + - SC/APC + - ST + - CS + - SN + - SMA 905 + - SMA 906 + - URM-P2 + - URM-P4 + - URM-P8 + - Splice + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortMapping' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - created + - device + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - name + - type + - url + FrontPortMapping: + type: object + properties: + position: + type: integer + rear_port: + type: integer + rear_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - position + - rear_port + FrontPortMappingRequest: + type: object + properties: + position: + type: integer + rear_port: + type: integer + rear_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - position + - rear_port + FrontPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortMappingRequest' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - type + FrontPortTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + label: + type: string + enum: + - 8P8C + - 8P6C + - 8P4C + - 8P2C + - 6P6C + - 6P4C + - 6P2C + - 4P4C + - 4P2C + - GG45 + - TERA 4P + - TERA 2P + - TERA 1P + - 110 Punch + - BNC + - F Connector + - N Connector + - MRJ21 + - FC + - FC/PC + - FC/UPC + - FC/APC + - LC + - LC/PC + - LC/UPC + - LC/APC + - LSH + - LSH/PC + - LSH/UPC + - LSH/APC + - LX.5 + - LX.5/PC + - LX.5/UPC + - LX.5/APC + - MPO + - MTRJ + - SC + - SC/PC + - SC/UPC + - SC/APC + - ST + - CS + - SN + - SMA 905 + - SMA 906 + - URM-P2 + - URM-P4 + - URM-P8 + - Splice + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateMapping' + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - type + - url + FrontPortTemplateMapping: + type: object + properties: + position: + type: integer + rear_port: + type: integer + rear_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - position + - rear_port + FrontPortTemplateMappingRequest: + type: object + properties: + position: + type: integer + rear_port: + type: integer + rear_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - position + - rear_port + FrontPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateMappingRequest' + description: + type: string + maxLength: 200 + required: + - name + - type + GenericObject: + type: object + description: Minimal representation of some generic object identified by ContentType + and PK. + properties: + object_type: + type: string + object_id: + type: integer + object: + nullable: true + readOnly: true + required: + - object + - object_id + - object_type + GenericObjectRequest: + type: object + description: Minimal representation of some generic object identified by ContentType + and PK. + properties: + object_type: + type: string + object_id: + type: integer + required: + - object_id + - object_type + Group: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 150 + description: + type: string + maxLength: 200 + permissions: + type: array + items: + $ref: '#/components/schemas/ObjectPermission' + user_count: + type: integer + readOnly: true + required: + - display + - display_url + - id + - name + - url + - user_count + GroupRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 150 + description: + type: string + maxLength: 200 + permissions: + type: array + items: + type: integer + required: + - name + IKEPolicy: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + version: + type: object + properties: + value: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - IKEv1 + * `2` - IKEv2 + x-spec-enum-id: 00872b77916a1fde + label: + type: string + enum: + - IKEv1 + - IKEv2 + mode: + type: object + properties: + value: + enum: + - aggressive + - main + type: string + description: |- + * `aggressive` - Aggressive + * `main` - Main + x-spec-enum-id: 64c1be7bdb2548ca + label: + type: string + enum: + - Aggressive + - Main + proposals: + type: array + items: + $ref: '#/components/schemas/IKEProposal' + preshared_key: + type: string + title: Pre-shared key + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - url + - version + IKEPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - IKEv1 + * `2` - IKEv2 + x-spec-enum-id: 00872b77916a1fde + mode: + enum: + - aggressive + - main + type: string + description: |- + * `aggressive` - Aggressive + * `main` - Main + x-spec-enum-id: 64c1be7bdb2548ca + proposals: + type: array + items: + type: integer + preshared_key: + type: string + title: Pre-shared key + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - version + IKEProposal: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + authentication_method: + type: object + properties: + value: + enum: + - preshared-keys + - certificates + - rsa-signatures + - dsa-signatures + type: string + description: |- + * `preshared-keys` - Pre-shared keys + * `certificates` - Certificates + * `rsa-signatures` - RSA signatures + * `dsa-signatures` - DSA signatures + x-spec-enum-id: a21158c52d0c455a + label: + type: string + enum: + - Pre-shared keys + - Certificates + - RSA signatures + - DSA signatures + encryption_algorithm: + type: object + properties: + value: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + label: + type: string + enum: + - 128-bit AES (CBC) + - 128-bit AES (GCM) + - 192-bit AES (CBC) + - 192-bit AES (GCM) + - 256-bit AES (CBC) + - 256-bit AES (GCM) + - 3DES + - DES + authentication_algorithm: + type: object + properties: + value: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + label: + type: string + enum: + - SHA-1 HMAC + - SHA-256 HMAC + - SHA-384 HMAC + - SHA-512 HMAC + - MD5 HMAC + group: + type: object + properties: + value: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + type: integer + description: |- + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + x-spec-enum-id: dbef43be795462a8 + label: + type: string + enum: + - Group 1 + - Group 2 + - Group 5 + - Group 14 + - Group 15 + - Group 16 + - Group 17 + - Group 18 + - Group 19 + - Group 20 + - Group 21 + - Group 22 + - Group 23 + - Group 24 + - Group 25 + - Group 26 + - Group 27 + - Group 28 + - Group 29 + - Group 30 + - Group 31 + - Group 32 + - Group 33 + - Group 34 + sa_lifetime: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Security association lifetime (in seconds) + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - authentication_method + - created + - display + - display_url + - encryption_algorithm + - group + - id + - last_updated + - name + - url + IKEProposalRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + authentication_method: + enum: + - preshared-keys + - certificates + - rsa-signatures + - dsa-signatures + type: string + description: |- + * `preshared-keys` - Pre-shared keys + * `certificates` - Certificates + * `rsa-signatures` - RSA signatures + * `dsa-signatures` - DSA signatures + x-spec-enum-id: a21158c52d0c455a + encryption_algorithm: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + authentication_algorithm: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + group: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + type: integer + description: |- + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + x-spec-enum-id: dbef43be795462a8 + sa_lifetime: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Security association lifetime (in seconds) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - authentication_method + - encryption_algorithm + - group + - name + IPAddress: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + family: + type: object + properties: + value: + enum: + - 4 + - 6 + type: integer + description: |- + * `4` - IPv4 + * `6` - IPv6 + x-spec-enum-id: d72003fd1af3603d + label: + type: string + enum: + - IPv4 + - IPv6 + readOnly: true + address: + type: string + vrf: + allOf: + - $ref: '#/components/schemas/BriefVRF' + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + status: + type: object + properties: + value: + enum: + - active + - reserved + - deprecated + - dhcp + - slaac + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + * `dhcp` - DHCP + * `slaac` - SLAAC + x-spec-enum-id: c421c4c4a0fa7a2a + label: + type: string + enum: + - Active + - Reserved + - Deprecated + - DHCP + - SLAAC + role: + type: object + properties: + value: + enum: + - loopback + - secondary + - anycast + - vip + - vrrp + - hsrp + - glbp + - carp + - '' + type: string + description: |- + * `loopback` - Loopback + * `secondary` - Secondary + * `anycast` - Anycast + * `vip` - VIP + * `vrrp` - VRRP + * `hsrp` - HSRP + * `glbp` - GLBP + * `carp` - CARP + x-spec-enum-id: 53dca4cddd7b344a + label: + type: string + enum: + - Loopback + - Secondary + - Anycast + - VIP + - VRRP + - HSRP + - GLBP + - CARP + assigned_object_type: + type: string + nullable: true + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + assigned_object: + readOnly: true + nullable: true + nat_inside: + allOf: + - $ref: '#/components/schemas/NestedIPAddress' + nullable: true + nat_outside: + type: array + items: + $ref: '#/components/schemas/NestedIPAddress' + readOnly: true + dns_name: + type: string + description: Hostname or FQDN (not case-sensitive) + pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ + maxLength: 255 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - address + - assigned_object + - created + - display + - display_url + - family + - id + - last_updated + - nat_outside + - url + IPAddressRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + address: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + - dhcp + - slaac + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + * `dhcp` - DHCP + * `slaac` - SLAAC + x-spec-enum-id: c421c4c4a0fa7a2a + role: + enum: + - loopback + - secondary + - anycast + - vip + - vrrp + - hsrp + - glbp + - carp + - '' + type: string + description: |- + * `loopback` - Loopback + * `secondary` - Secondary + * `anycast` - Anycast + * `vip` - VIP + * `vrrp` - VRRP + * `hsrp` - HSRP + * `glbp` - GLBP + * `carp` - CARP + x-spec-enum-id: 53dca4cddd7b344a + assigned_object_type: + type: string + nullable: true + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + nat_inside: + allOf: + - $ref: '#/components/schemas/NestedIPAddressRequest' + nullable: true + dns_name: + type: string + description: Hostname or FQDN (not case-sensitive) + pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ + maxLength: 255 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - address + IPRange: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + family: + type: object + properties: + value: + enum: + - 4 + - 6 + type: integer + description: |- + * `4` - IPv4 + * `6` - IPv6 + x-spec-enum-id: d72003fd1af3603d + label: + type: string + enum: + - IPv4 + - IPv6 + readOnly: true + start_address: + type: string + end_address: + type: string + size: + type: integer + readOnly: true + vrf: + allOf: + - $ref: '#/components/schemas/BriefVRF' + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + status: + type: object + properties: + value: + enum: + - active + - reserved + - deprecated + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + x-spec-enum-id: ca933c38b935e547 + label: + type: string + enum: + - Active + - Reserved + - Deprecated + role: + allOf: + - $ref: '#/components/schemas/BriefRole' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + mark_populated: + type: boolean + description: Prevent the creation of IP addresses within this range + mark_utilized: + type: boolean + description: Report space as fully utilized + required: + - created + - display + - display_url + - end_address + - family + - id + - last_updated + - size + - start_address + - url + IPRangeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + start_address: + type: string + minLength: 1 + end_address: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + x-spec-enum-id: ca933c38b935e547 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + mark_populated: + type: boolean + description: Prevent the creation of IP addresses within this range + mark_utilized: + type: boolean + description: Report space as fully utilized + required: + - end_address + - start_address + IPSecPolicy: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + proposals: + type: array + items: + $ref: '#/components/schemas/IPSecProposal' + pfs_group: + type: object + properties: + value: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + type: integer + description: |- + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + x-spec-enum-id: dbef43be795462a8 + label: + type: string + enum: + - Group 1 + - Group 2 + - Group 5 + - Group 14 + - Group 15 + - Group 16 + - Group 17 + - Group 18 + - Group 19 + - Group 20 + - Group 21 + - Group 22 + - Group 23 + - Group 24 + - Group 25 + - Group 26 + - Group 27 + - Group 28 + - Group 29 + - Group 30 + - Group 31 + - Group 32 + - Group 33 + - Group 34 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - url + IPSecPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + proposals: + type: array + items: + type: integer + pfs_group: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + type: integer + description: |- + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + x-spec-enum-id: dbef43be795462a8 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + IPSecProfile: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + mode: + type: object + properties: + value: + enum: + - esp + - ah + type: string + description: |- + * `esp` - ESP + * `ah` - AH + x-spec-enum-id: 87ac6ada0da14ccf + label: + type: string + enum: + - ESP + - AH + ike_policy: + $ref: '#/components/schemas/BriefIKEPolicy' + ipsec_policy: + $ref: '#/components/schemas/BriefIPSecPolicy' + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - ike_policy + - ipsec_policy + - last_updated + - mode + - name + - url + IPSecProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + mode: + enum: + - esp + - ah + type: string + description: |- + * `esp` - ESP + * `ah` - AH + x-spec-enum-id: 87ac6ada0da14ccf + ike_policy: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefIKEPolicyRequest' + ipsec_policy: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefIPSecPolicyRequest' + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - ike_policy + - ipsec_policy + - mode + - name + IPSecProposal: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + encryption_algorithm: + type: object + properties: + value: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + label: + type: string + enum: + - 128-bit AES (CBC) + - 128-bit AES (GCM) + - 192-bit AES (CBC) + - 192-bit AES (GCM) + - 256-bit AES (CBC) + - 256-bit AES (GCM) + - 3DES + - DES + authentication_algorithm: + type: object + properties: + value: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + label: + type: string + enum: + - SHA-1 HMAC + - SHA-256 HMAC + - SHA-384 HMAC + - SHA-512 HMAC + - MD5 HMAC + sa_lifetime_seconds: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (seconds) + description: Security association lifetime (seconds) + sa_lifetime_data: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (KB) + description: Security association lifetime (in kilobytes) + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - url + IPSecProposalRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + encryption_algorithm: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + authentication_algorithm: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + sa_lifetime_seconds: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (seconds) + description: Security association lifetime (seconds) + sa_lifetime_data: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (KB) + description: Security association lifetime (in kilobytes) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + ImageAttachment: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + parent: + readOnly: true + nullable: true + name: + type: string + maxLength: 50 + image: + type: string + format: uri + description: + type: string + maxLength: 200 + image_height: + type: integer + readOnly: true + image_width: + type: integer + readOnly: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - image + - image_height + - image_width + - last_updated + - object_id + - object_type + - parent + - url + ImageAttachmentRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + name: + type: string + maxLength: 50 + image: + type: string + format: binary + description: + type: string + maxLength: 200 + required: + - image + - object_id + - object_type + IntegerRange: + type: array + items: + type: integer + minItems: 2 + maxItems: 2 + example: + - 10 + - 20 + IntegerRangeRequest: + type: array + items: + type: integer + minItems: 2 + maxItems: 2 + example: + - 10 + - 20 + Interface: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + vdcs: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContext' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + label: + type: string + enum: + - Virtual + - Bridge + - Link Aggregation Group (LAG) + - 100BASE-FX (10/100ME) + - 100BASE-LFX (10/100ME) + - 100BASE-TX (10/100ME) + - 100BASE-T1 (10/100ME) + - 1000BASE-BX10-D (1GE BiDi Down) + - 1000BASE-BX10-U (1GE BiDi Up) + - 1000BASE-CWDM (1GE) + - 1000BASE-CX (1GE DAC) + - 1000BASE-DWDM (1GE) + - 1000BASE-EX (1GE) + - 1000BASE-LSX (1GE) + - 1000BASE-LX (1GE) + - 1000BASE-LX10/LH (1GE) + - 1000BASE-SX (1GE) + - 1000BASE-T (1GE) + - 1000BASE-TX (1GE) + - 1000BASE-ZX (1GE) + - 2.5GBASE-T (2.5GE) + - 5GBASE-T (5GE) + - 10GBASE-BR-D (10GE BiDi Down) + - 10GBASE-BR-U (10GE BiDi Up) + - 10GBASE-CU (10GE DAC Passive Twinax) + - 10GBASE-CX4 (10GE DAC) + - 10GBASE-ER (10GE) + - 10GBASE-LR (10GE) + - 10GBASE-LRM (10GE) + - 10GBASE-LX4 (10GE) + - 10GBASE-SR (10GE) + - 10GBASE-T (10GE) + - 10GBASE-ZR (10GE) + - 25GBASE-CR (25GE DAC) + - 25GBASE-ER (25GE) + - 25GBASE-LR (25GE) + - 25GBASE-SR (25GE) + - 25GBASE-T (25GE) + - 40GBASE-CR4 (40GE DAC) + - 40GBASE-ER4 (40GE) + - 40GBASE-FR4 (40GE) + - 40GBASE-LR4 (40GE) + - 40GBASE-SR4 (40GE) + - 40GBASE-SR4 (40GE BiDi) + - 50GBASE-CR (50GE DAC) + - 50GBASE-ER (50GE) + - 50GBASE-FR (50GE) + - 50GBASE-LR (50GE) + - 50GBASE-SR (50GE) + - 100GBASE-CR1 (100GE DAC) + - 100GBASE-CR2 (100GE DAC) + - 100GBASE-CR4 (100GE DAC) + - 100GBASE-CR10 (100GE DAC) + - 100GBASE-CWDM4 (100GE) + - 100GBASE-DR (100GE) + - 100GBASE-ER4 (100GE) + - 100GBASE-FR1 (100GE) + - 100GBASE-LR1 (100GE) + - 100GBASE-LR4 (100GE) + - 100GBASE-SR1 (100GE) + - 100GBASE-SR1.2 (100GE BiDi) + - 100GBASE-SR2 (100GE) + - 100GBASE-SR4 (100GE) + - 100GBASE-SR10 (100GE) + - 100GBASE-ZR (100GE) + - 200GBASE-CR2 (200GE) + - 200GBASE-CR4 (200GE) + - 200GBASE-DR4 (200GE) + - 200GBASE-ER4 (200GE) + - 200GBASE-FR4 (200GE) + - 200GBASE-LR4 (200GE) + - 200GBASE-SR2 (200GE) + - 200GBASE-SR4 (200GE) + - 200GBASE-VR2 (200GE) + - 400GBASE-CR4 (400GE) + - 400GBASE-DR4 (400GE) + - 400GBASE-ER8 (400GE) + - 400GBASE-FR4 (400GE) + - 400GBASE-FR8 (400GE) + - 400GBASE-LR4 (400GE) + - 400GBASE-LR8 (400GE) + - 400GBASE-SR4 (400GE) + - 400GBASE-SR4.2 (400GE BiDi) + - 400GBASE-SR8 (400GE) + - 400GBASE-SR16 (400GE) + - 400GBASE-VR4 (400GE) + - 400GBASE-ZR (400GE) + - 800GBASE-CR8 (800GE) + - 800GBASE-DR8 (800GE) + - 800GBASE-SR8 (800GE) + - 800GBASE-VR8 (800GE) + - 1.6TBASE-CR8 (1.6TE) + - 1.6TBASE-DR8 (1.6TE) + - 1.6TBASE-DR8-2 (1.6TE) + - SFP (100ME) + - GBIC (1GE) + - SFP (1GE) + - SFP (2.5GE) + - SFP+ (10GE) + - XENPAK (10GE) + - XFP (10GE) + - X2 (10GE) + - SFP28 (25GE) + - QSFP+ (40GE) + - QSFP28 (50GE) + - SFP56 (50GE) + - CFP (100GE) + - CFP2 (100GE) + - CFP4 (100GE) + - CXP (100GE) + - Cisco CPAK (100GE) + - DSFP (100GE) + - QSFP28 (100GE) + - QSFP-DD (100GE) + - SFP-DD (100GE) + - CFP2 (200GE) + - QSFP56 (200GE) + - QSFP-DD (200GE) + - QSFP112 (400GE) + - QSFP-DD (400GE) + - CDFP (400GE) + - CFP2 (400GE) + - CPF8 (400GE) + - OSFP (400GE) + - OSFP-RHS (400GE) + - OSFP (800GE) + - QSFP-DD (800GE) + - OSFP1600 (1.6TE) + - OSFP1600-RHS (1.6TE) + - QSFP-DD1600 (1.6TE) + - 1000BASE-KX (1GE) + - 2.5GBASE-KX (2.5GE) + - 5GBASE-KR (5GE) + - 10GBASE-KR (10GE) + - 10GBASE-KX4 (10GE) + - 25GBASE-KR (25GE) + - 40GBASE-KR4 (40GE) + - 50GBASE-KR (50GE) + - 100GBASE-KP4 (100GE) + - 100GBASE-KR2 (100GE) + - 100GBASE-KR4 (100GE) + - 1.6TBASE-KR8 (1.6TE) + - IEEE 802.11a + - IEEE 802.11b/g + - IEEE 802.11n (Wi-Fi 4) + - IEEE 802.11ac (Wi-Fi 5) + - IEEE 802.11ad (WiGig) + - IEEE 802.11ax (Wi-Fi 6) + - IEEE 802.11ay (WiGig) + - IEEE 802.11be (Wi-Fi 7) + - IEEE 802.15.1 (Bluetooth) + - IEEE 802.15.4 (LR-WPAN) + - Other (Wireless) + - GSM + - CDMA + - LTE + - 4G + - 5G + - OC-3/STM-1 + - OC-12/STM-4 + - OC-48/STM-16 + - OC-192/STM-64 + - OC-768/STM-256 + - OC-1920/STM-640 + - OC-3840/STM-1234 + - SFP (1GFC) + - SFP (2GFC) + - SFP (4GFC) + - SFP+ (8GFC) + - SFP+ (16GFC) + - SFP28 (32GFC) + - SFP+ (32GFC) + - QSFP+ (64GFC) + - SFP-DD (64GFC) + - SFP+ (64GFC) + - QSFP28 (128GFC) + - SDR (2 Gbps) + - DDR (4 Gbps) + - QDR (8 Gbps) + - FDR10 (10 Gbps) + - FDR (13.5 Gbps) + - EDR (25 Gbps) + - HDR (50 Gbps) + - NDR (100 Gbps) + - XDR (250 Gbps) + - T1 (1.544 Mbps) + - E1 (2.048 Mbps) + - T3 (45 Mbps) + - E3 (34 Mbps) + - xDSL + - DOCSIS + - MoCA + - BPON (622 Mbps / 155 Mbps) + - EPON (1 Gbps) + - 10G-EPON (10 Gbps) + - GPON (2.5 Gbps / 1.25 Gbps) + - XG-PON (10 Gbps / 2.5 Gbps) + - XGS-PON (10 Gbps) + - NG-PON2 (TWDM-PON) (4x10 Gbps) + - 25G-PON (25 Gbps) + - 50G-PON (50 Gbps) + - Cisco StackWise + - Cisco StackWise Plus + - Cisco FlexStack + - Cisco FlexStack Plus + - Cisco StackWise-80 + - Cisco StackWise-160 + - Cisco StackWise-320 + - Cisco StackWise-480 + - Cisco StackWise-1T + - Juniper VCP + - Extreme SummitStack + - Extreme SummitStack-128 + - Extreme SummitStack-256 + - Extreme SummitStack-512 + - Other + enabled: + type: boolean + parent: + allOf: + - $ref: '#/components/schemas/NestedInterface' + nullable: true + bridge: + allOf: + - $ref: '#/components/schemas/NestedInterface' + nullable: true + bridge_interfaces: + type: array + items: + $ref: '#/components/schemas/NestedInterface' + readOnly: true + lag: + allOf: + - $ref: '#/components/schemas/NestedInterface' + nullable: true + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + mac_address: + type: string + readOnly: true + nullable: true + primary_mac_address: + allOf: + - $ref: '#/components/schemas/BriefMACAddress' + nullable: true + mac_addresses: + type: array + items: + $ref: '#/components/schemas/BriefMACAddress' + readOnly: true + nullable: true + speed: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + title: Speed (Kbps) + duplex: + type: object + properties: + value: + enum: + - half + - full + - auto + - '' + - null + type: string + description: |- + * `half` - Half + * `full` - Full + * `auto` - Auto + x-spec-enum-id: 368458a2b67c916b + label: + type: string + enum: + - Half + - Full + - Auto + nullable: true + wwn: + type: string + nullable: true + mgmt_only: + type: boolean + title: Management only + description: This interface is used only for out-of-band management + description: + type: string + maxLength: 200 + mode: + type: object + properties: + value: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + type: string + description: |- + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + x-spec-enum-id: 84129b71b974ebe5 + label: + type: string + enum: + - Access + - Tagged + - Tagged (All) + - Q-in-Q (802.1ad) + rf_role: + type: object + properties: + value: + enum: + - ap + - station + - '' + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + label: + type: string + enum: + - Access point + - Station + rf_channel: + type: object + properties: + value: + enum: + - 2.4g-1-2412-22 + - 2.4g-2-2417-22 + - 2.4g-3-2422-22 + - 2.4g-4-2427-22 + - 2.4g-5-2432-22 + - 2.4g-6-2437-22 + - 2.4g-7-2442-22 + - 2.4g-8-2447-22 + - 2.4g-9-2452-22 + - 2.4g-10-2457-22 + - 2.4g-11-2462-22 + - 2.4g-12-2467-22 + - 2.4g-13-2472-22 + - 5g-32-5160-20 + - 5g-34-5170-40 + - 5g-36-5180-20 + - 5g-38-5190-40 + - 5g-40-5200-20 + - 5g-42-5210-80 + - 5g-44-5220-20 + - 5g-46-5230-40 + - 5g-48-5240-20 + - 5g-50-5250-160 + - 5g-52-5260-20 + - 5g-54-5270-40 + - 5g-56-5280-20 + - 5g-58-5290-80 + - 5g-60-5300-20 + - 5g-62-5310-40 + - 5g-64-5320-20 + - 5g-100-5500-20 + - 5g-102-5510-40 + - 5g-104-5520-20 + - 5g-106-5530-80 + - 5g-108-5540-20 + - 5g-110-5550-40 + - 5g-112-5560-20 + - 5g-114-5570-160 + - 5g-116-5580-20 + - 5g-118-5590-40 + - 5g-120-5600-20 + - 5g-122-5610-80 + - 5g-124-5620-20 + - 5g-126-5630-40 + - 5g-128-5640-20 + - 5g-132-5660-20 + - 5g-134-5670-40 + - 5g-136-5680-20 + - 5g-138-5690-80 + - 5g-140-5700-20 + - 5g-142-5710-40 + - 5g-144-5720-20 + - 5g-149-5745-20 + - 5g-151-5755-40 + - 5g-153-5765-20 + - 5g-155-5775-80 + - 5g-157-5785-20 + - 5g-159-5795-40 + - 5g-161-5805-20 + - 5g-163-5815-160 + - 5g-165-5825-20 + - 5g-167-5835-40 + - 5g-169-5845-20 + - 5g-171-5855-80 + - 5g-173-5865-20 + - 5g-175-5875-40 + - 5g-177-5885-20 + - 6g-1-5955-20 + - 6g-3-5965-40 + - 6g-5-5975-20 + - 6g-7-5985-80 + - 6g-9-5995-20 + - 6g-11-6005-40 + - 6g-13-6015-20 + - 6g-15-6025-160 + - 6g-17-6035-20 + - 6g-19-6045-40 + - 6g-21-6055-20 + - 6g-23-6065-80 + - 6g-25-6075-20 + - 6g-27-6085-40 + - 6g-29-6095-20 + - 6g-31-6105-320 + - 6g-33-6115-20 + - 6g-35-6125-40 + - 6g-37-6135-20 + - 6g-39-6145-80 + - 6g-41-6155-20 + - 6g-43-6165-40 + - 6g-45-6175-20 + - 6g-47-6185-160 + - 6g-49-6195-20 + - 6g-51-6205-40 + - 6g-53-6215-20 + - 6g-55-6225-80 + - 6g-57-6235-20 + - 6g-59-6245-40 + - 6g-61-6255-20 + - 6g-65-6275-20 + - 6g-67-6285-40 + - 6g-69-6295-20 + - 6g-71-6305-80 + - 6g-73-6315-20 + - 6g-75-6325-40 + - 6g-77-6335-20 + - 6g-79-6345-160 + - 6g-81-6355-20 + - 6g-83-6365-40 + - 6g-85-6375-20 + - 6g-87-6385-80 + - 6g-89-6395-20 + - 6g-91-6405-40 + - 6g-93-6415-20 + - 6g-95-6425-320 + - 6g-97-6435-20 + - 6g-99-6445-40 + - 6g-101-6455-20 + - 6g-103-6465-80 + - 6g-105-6475-20 + - 6g-107-6485-40 + - 6g-109-6495-20 + - 6g-111-6505-160 + - 6g-113-6515-20 + - 6g-115-6525-40 + - 6g-117-6535-20 + - 6g-119-6545-80 + - 6g-121-6555-20 + - 6g-123-6565-40 + - 6g-125-6575-20 + - 6g-129-6595-20 + - 6g-131-6605-40 + - 6g-133-6615-20 + - 6g-135-6625-80 + - 6g-137-6635-20 + - 6g-139-6645-40 + - 6g-141-6655-20 + - 6g-143-6665-160 + - 6g-145-6675-20 + - 6g-147-6685-40 + - 6g-149-6695-20 + - 6g-151-6705-80 + - 6g-153-6715-20 + - 6g-155-6725-40 + - 6g-157-6735-20 + - 6g-159-6745-320 + - 6g-161-6755-20 + - 6g-163-6765-40 + - 6g-165-6775-20 + - 6g-167-6785-80 + - 6g-169-6795-20 + - 6g-171-6805-40 + - 6g-173-6815-20 + - 6g-175-6825-160 + - 6g-177-6835-20 + - 6g-179-6845-40 + - 6g-181-6855-20 + - 6g-183-6865-80 + - 6g-185-6875-20 + - 6g-187-6885-40 + - 6g-189-6895-20 + - 6g-193-6915-20 + - 6g-195-6925-40 + - 6g-197-6935-20 + - 6g-199-6945-80 + - 6g-201-6955-20 + - 6g-203-6965-40 + - 6g-205-6975-20 + - 6g-207-6985-160 + - 6g-209-6995-20 + - 6g-211-7005-40 + - 6g-213-7015-20 + - 6g-215-7025-80 + - 6g-217-7035-20 + - 6g-219-7045-40 + - 6g-221-7055-20 + - 6g-225-7075-20 + - 6g-227-7085-40 + - 6g-229-7095-20 + - 6g-233-7115-20 + - 60g-1-58320-2160 + - 60g-2-60480-2160 + - 60g-3-62640-2160 + - 60g-4-64800-2160 + - 60g-5-66960-2160 + - 60g-6-69120-2160 + - 60g-9-59400-4320 + - 60g-10-61560-4320 + - 60g-11-63720-4320 + - 60g-12-65880-4320 + - 60g-13-68040-4320 + - 60g-17-60480-6480 + - 60g-18-62640-6480 + - 60g-19-64800-6480 + - 60g-20-66960-6480 + - 60g-25-61560-6480 + - 60g-26-63720-6480 + - 60g-27-65880-6480 + - '' + type: string + description: |- + * `2.4g-1-2412-22` - 1 (2412 MHz) + * `2.4g-2-2417-22` - 2 (2417 MHz) + * `2.4g-3-2422-22` - 3 (2422 MHz) + * `2.4g-4-2427-22` - 4 (2427 MHz) + * `2.4g-5-2432-22` - 5 (2432 MHz) + * `2.4g-6-2437-22` - 6 (2437 MHz) + * `2.4g-7-2442-22` - 7 (2442 MHz) + * `2.4g-8-2447-22` - 8 (2447 MHz) + * `2.4g-9-2452-22` - 9 (2452 MHz) + * `2.4g-10-2457-22` - 10 (2457 MHz) + * `2.4g-11-2462-22` - 11 (2462 MHz) + * `2.4g-12-2467-22` - 12 (2467 MHz) + * `2.4g-13-2472-22` - 13 (2472 MHz) + * `5g-32-5160-20` - 32 (5160/20 MHz) + * `5g-34-5170-40` - 34 (5170/40 MHz) + * `5g-36-5180-20` - 36 (5180/20 MHz) + * `5g-38-5190-40` - 38 (5190/40 MHz) + * `5g-40-5200-20` - 40 (5200/20 MHz) + * `5g-42-5210-80` - 42 (5210/80 MHz) + * `5g-44-5220-20` - 44 (5220/20 MHz) + * `5g-46-5230-40` - 46 (5230/40 MHz) + * `5g-48-5240-20` - 48 (5240/20 MHz) + * `5g-50-5250-160` - 50 (5250/160 MHz) + * `5g-52-5260-20` - 52 (5260/20 MHz) + * `5g-54-5270-40` - 54 (5270/40 MHz) + * `5g-56-5280-20` - 56 (5280/20 MHz) + * `5g-58-5290-80` - 58 (5290/80 MHz) + * `5g-60-5300-20` - 60 (5300/20 MHz) + * `5g-62-5310-40` - 62 (5310/40 MHz) + * `5g-64-5320-20` - 64 (5320/20 MHz) + * `5g-100-5500-20` - 100 (5500/20 MHz) + * `5g-102-5510-40` - 102 (5510/40 MHz) + * `5g-104-5520-20` - 104 (5520/20 MHz) + * `5g-106-5530-80` - 106 (5530/80 MHz) + * `5g-108-5540-20` - 108 (5540/20 MHz) + * `5g-110-5550-40` - 110 (5550/40 MHz) + * `5g-112-5560-20` - 112 (5560/20 MHz) + * `5g-114-5570-160` - 114 (5570/160 MHz) + * `5g-116-5580-20` - 116 (5580/20 MHz) + * `5g-118-5590-40` - 118 (5590/40 MHz) + * `5g-120-5600-20` - 120 (5600/20 MHz) + * `5g-122-5610-80` - 122 (5610/80 MHz) + * `5g-124-5620-20` - 124 (5620/20 MHz) + * `5g-126-5630-40` - 126 (5630/40 MHz) + * `5g-128-5640-20` - 128 (5640/20 MHz) + * `5g-132-5660-20` - 132 (5660/20 MHz) + * `5g-134-5670-40` - 134 (5670/40 MHz) + * `5g-136-5680-20` - 136 (5680/20 MHz) + * `5g-138-5690-80` - 138 (5690/80 MHz) + * `5g-140-5700-20` - 140 (5700/20 MHz) + * `5g-142-5710-40` - 142 (5710/40 MHz) + * `5g-144-5720-20` - 144 (5720/20 MHz) + * `5g-149-5745-20` - 149 (5745/20 MHz) + * `5g-151-5755-40` - 151 (5755/40 MHz) + * `5g-153-5765-20` - 153 (5765/20 MHz) + * `5g-155-5775-80` - 155 (5775/80 MHz) + * `5g-157-5785-20` - 157 (5785/20 MHz) + * `5g-159-5795-40` - 159 (5795/40 MHz) + * `5g-161-5805-20` - 161 (5805/20 MHz) + * `5g-163-5815-160` - 163 (5815/160 MHz) + * `5g-165-5825-20` - 165 (5825/20 MHz) + * `5g-167-5835-40` - 167 (5835/40 MHz) + * `5g-169-5845-20` - 169 (5845/20 MHz) + * `5g-171-5855-80` - 171 (5855/80 MHz) + * `5g-173-5865-20` - 173 (5865/20 MHz) + * `5g-175-5875-40` - 175 (5875/40 MHz) + * `5g-177-5885-20` - 177 (5885/20 MHz) + * `6g-1-5955-20` - 1 (5955/20 MHz) + * `6g-3-5965-40` - 3 (5965/40 MHz) + * `6g-5-5975-20` - 5 (5975/20 MHz) + * `6g-7-5985-80` - 7 (5985/80 MHz) + * `6g-9-5995-20` - 9 (5995/20 MHz) + * `6g-11-6005-40` - 11 (6005/40 MHz) + * `6g-13-6015-20` - 13 (6015/20 MHz) + * `6g-15-6025-160` - 15 (6025/160 MHz) + * `6g-17-6035-20` - 17 (6035/20 MHz) + * `6g-19-6045-40` - 19 (6045/40 MHz) + * `6g-21-6055-20` - 21 (6055/20 MHz) + * `6g-23-6065-80` - 23 (6065/80 MHz) + * `6g-25-6075-20` - 25 (6075/20 MHz) + * `6g-27-6085-40` - 27 (6085/40 MHz) + * `6g-29-6095-20` - 29 (6095/20 MHz) + * `6g-31-6105-320` - 31 (6105/320 MHz) + * `6g-33-6115-20` - 33 (6115/20 MHz) + * `6g-35-6125-40` - 35 (6125/40 MHz) + * `6g-37-6135-20` - 37 (6135/20 MHz) + * `6g-39-6145-80` - 39 (6145/80 MHz) + * `6g-41-6155-20` - 41 (6155/20 MHz) + * `6g-43-6165-40` - 43 (6165/40 MHz) + * `6g-45-6175-20` - 45 (6175/20 MHz) + * `6g-47-6185-160` - 47 (6185/160 MHz) + * `6g-49-6195-20` - 49 (6195/20 MHz) + * `6g-51-6205-40` - 51 (6205/40 MHz) + * `6g-53-6215-20` - 53 (6215/20 MHz) + * `6g-55-6225-80` - 55 (6225/80 MHz) + * `6g-57-6235-20` - 57 (6235/20 MHz) + * `6g-59-6245-40` - 59 (6245/40 MHz) + * `6g-61-6255-20` - 61 (6255/20 MHz) + * `6g-65-6275-20` - 65 (6275/20 MHz) + * `6g-67-6285-40` - 67 (6285/40 MHz) + * `6g-69-6295-20` - 69 (6295/20 MHz) + * `6g-71-6305-80` - 71 (6305/80 MHz) + * `6g-73-6315-20` - 73 (6315/20 MHz) + * `6g-75-6325-40` - 75 (6325/40 MHz) + * `6g-77-6335-20` - 77 (6335/20 MHz) + * `6g-79-6345-160` - 79 (6345/160 MHz) + * `6g-81-6355-20` - 81 (6355/20 MHz) + * `6g-83-6365-40` - 83 (6365/40 MHz) + * `6g-85-6375-20` - 85 (6375/20 MHz) + * `6g-87-6385-80` - 87 (6385/80 MHz) + * `6g-89-6395-20` - 89 (6395/20 MHz) + * `6g-91-6405-40` - 91 (6405/40 MHz) + * `6g-93-6415-20` - 93 (6415/20 MHz) + * `6g-95-6425-320` - 95 (6425/320 MHz) + * `6g-97-6435-20` - 97 (6435/20 MHz) + * `6g-99-6445-40` - 99 (6445/40 MHz) + * `6g-101-6455-20` - 101 (6455/20 MHz) + * `6g-103-6465-80` - 103 (6465/80 MHz) + * `6g-105-6475-20` - 105 (6475/20 MHz) + * `6g-107-6485-40` - 107 (6485/40 MHz) + * `6g-109-6495-20` - 109 (6495/20 MHz) + * `6g-111-6505-160` - 111 (6505/160 MHz) + * `6g-113-6515-20` - 113 (6515/20 MHz) + * `6g-115-6525-40` - 115 (6525/40 MHz) + * `6g-117-6535-20` - 117 (6535/20 MHz) + * `6g-119-6545-80` - 119 (6545/80 MHz) + * `6g-121-6555-20` - 121 (6555/20 MHz) + * `6g-123-6565-40` - 123 (6565/40 MHz) + * `6g-125-6575-20` - 125 (6575/20 MHz) + * `6g-129-6595-20` - 129 (6595/20 MHz) + * `6g-131-6605-40` - 131 (6605/40 MHz) + * `6g-133-6615-20` - 133 (6615/20 MHz) + * `6g-135-6625-80` - 135 (6625/80 MHz) + * `6g-137-6635-20` - 137 (6635/20 MHz) + * `6g-139-6645-40` - 139 (6645/40 MHz) + * `6g-141-6655-20` - 141 (6655/20 MHz) + * `6g-143-6665-160` - 143 (6665/160 MHz) + * `6g-145-6675-20` - 145 (6675/20 MHz) + * `6g-147-6685-40` - 147 (6685/40 MHz) + * `6g-149-6695-20` - 149 (6695/20 MHz) + * `6g-151-6705-80` - 151 (6705/80 MHz) + * `6g-153-6715-20` - 153 (6715/20 MHz) + * `6g-155-6725-40` - 155 (6725/40 MHz) + * `6g-157-6735-20` - 157 (6735/20 MHz) + * `6g-159-6745-320` - 159 (6745/320 MHz) + * `6g-161-6755-20` - 161 (6755/20 MHz) + * `6g-163-6765-40` - 163 (6765/40 MHz) + * `6g-165-6775-20` - 165 (6775/20 MHz) + * `6g-167-6785-80` - 167 (6785/80 MHz) + * `6g-169-6795-20` - 169 (6795/20 MHz) + * `6g-171-6805-40` - 171 (6805/40 MHz) + * `6g-173-6815-20` - 173 (6815/20 MHz) + * `6g-175-6825-160` - 175 (6825/160 MHz) + * `6g-177-6835-20` - 177 (6835/20 MHz) + * `6g-179-6845-40` - 179 (6845/40 MHz) + * `6g-181-6855-20` - 181 (6855/20 MHz) + * `6g-183-6865-80` - 183 (6865/80 MHz) + * `6g-185-6875-20` - 185 (6875/20 MHz) + * `6g-187-6885-40` - 187 (6885/40 MHz) + * `6g-189-6895-20` - 189 (6895/20 MHz) + * `6g-193-6915-20` - 193 (6915/20 MHz) + * `6g-195-6925-40` - 195 (6925/40 MHz) + * `6g-197-6935-20` - 197 (6935/20 MHz) + * `6g-199-6945-80` - 199 (6945/80 MHz) + * `6g-201-6955-20` - 201 (6955/20 MHz) + * `6g-203-6965-40` - 203 (6965/40 MHz) + * `6g-205-6975-20` - 205 (6975/20 MHz) + * `6g-207-6985-160` - 207 (6985/160 MHz) + * `6g-209-6995-20` - 209 (6995/20 MHz) + * `6g-211-7005-40` - 211 (7005/40 MHz) + * `6g-213-7015-20` - 213 (7015/20 MHz) + * `6g-215-7025-80` - 215 (7025/80 MHz) + * `6g-217-7035-20` - 217 (7035/20 MHz) + * `6g-219-7045-40` - 219 (7045/40 MHz) + * `6g-221-7055-20` - 221 (7055/20 MHz) + * `6g-225-7075-20` - 225 (7075/20 MHz) + * `6g-227-7085-40` - 227 (7085/40 MHz) + * `6g-229-7095-20` - 229 (7095/20 MHz) + * `6g-233-7115-20` - 233 (7115/20 MHz) + * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) + * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) + * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) + * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) + * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) + * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) + * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) + * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) + * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) + * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) + * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) + * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) + * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) + * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) + * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) + * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) + * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) + * `60g-27-65880-6480` - 27 (65.88/8.64 GHz) + x-spec-enum-id: 70cf66176c475063 + label: + type: string + enum: + - 1 (2412 MHz) + - 2 (2417 MHz) + - 3 (2422 MHz) + - 4 (2427 MHz) + - 5 (2432 MHz) + - 6 (2437 MHz) + - 7 (2442 MHz) + - 8 (2447 MHz) + - 9 (2452 MHz) + - 10 (2457 MHz) + - 11 (2462 MHz) + - 12 (2467 MHz) + - 13 (2472 MHz) + - 32 (5160/20 MHz) + - 34 (5170/40 MHz) + - 36 (5180/20 MHz) + - 38 (5190/40 MHz) + - 40 (5200/20 MHz) + - 42 (5210/80 MHz) + - 44 (5220/20 MHz) + - 46 (5230/40 MHz) + - 48 (5240/20 MHz) + - 50 (5250/160 MHz) + - 52 (5260/20 MHz) + - 54 (5270/40 MHz) + - 56 (5280/20 MHz) + - 58 (5290/80 MHz) + - 60 (5300/20 MHz) + - 62 (5310/40 MHz) + - 64 (5320/20 MHz) + - 100 (5500/20 MHz) + - 102 (5510/40 MHz) + - 104 (5520/20 MHz) + - 106 (5530/80 MHz) + - 108 (5540/20 MHz) + - 110 (5550/40 MHz) + - 112 (5560/20 MHz) + - 114 (5570/160 MHz) + - 116 (5580/20 MHz) + - 118 (5590/40 MHz) + - 120 (5600/20 MHz) + - 122 (5610/80 MHz) + - 124 (5620/20 MHz) + - 126 (5630/40 MHz) + - 128 (5640/20 MHz) + - 132 (5660/20 MHz) + - 134 (5670/40 MHz) + - 136 (5680/20 MHz) + - 138 (5690/80 MHz) + - 140 (5700/20 MHz) + - 142 (5710/40 MHz) + - 144 (5720/20 MHz) + - 149 (5745/20 MHz) + - 151 (5755/40 MHz) + - 153 (5765/20 MHz) + - 155 (5775/80 MHz) + - 157 (5785/20 MHz) + - 159 (5795/40 MHz) + - 161 (5805/20 MHz) + - 163 (5815/160 MHz) + - 165 (5825/20 MHz) + - 167 (5835/40 MHz) + - 169 (5845/20 MHz) + - 171 (5855/80 MHz) + - 173 (5865/20 MHz) + - 175 (5875/40 MHz) + - 177 (5885/20 MHz) + - 1 (5955/20 MHz) + - 3 (5965/40 MHz) + - 5 (5975/20 MHz) + - 7 (5985/80 MHz) + - 9 (5995/20 MHz) + - 11 (6005/40 MHz) + - 13 (6015/20 MHz) + - 15 (6025/160 MHz) + - 17 (6035/20 MHz) + - 19 (6045/40 MHz) + - 21 (6055/20 MHz) + - 23 (6065/80 MHz) + - 25 (6075/20 MHz) + - 27 (6085/40 MHz) + - 29 (6095/20 MHz) + - 31 (6105/320 MHz) + - 33 (6115/20 MHz) + - 35 (6125/40 MHz) + - 37 (6135/20 MHz) + - 39 (6145/80 MHz) + - 41 (6155/20 MHz) + - 43 (6165/40 MHz) + - 45 (6175/20 MHz) + - 47 (6185/160 MHz) + - 49 (6195/20 MHz) + - 51 (6205/40 MHz) + - 53 (6215/20 MHz) + - 55 (6225/80 MHz) + - 57 (6235/20 MHz) + - 59 (6245/40 MHz) + - 61 (6255/20 MHz) + - 65 (6275/20 MHz) + - 67 (6285/40 MHz) + - 69 (6295/20 MHz) + - 71 (6305/80 MHz) + - 73 (6315/20 MHz) + - 75 (6325/40 MHz) + - 77 (6335/20 MHz) + - 79 (6345/160 MHz) + - 81 (6355/20 MHz) + - 83 (6365/40 MHz) + - 85 (6375/20 MHz) + - 87 (6385/80 MHz) + - 89 (6395/20 MHz) + - 91 (6405/40 MHz) + - 93 (6415/20 MHz) + - 95 (6425/320 MHz) + - 97 (6435/20 MHz) + - 99 (6445/40 MHz) + - 101 (6455/20 MHz) + - 103 (6465/80 MHz) + - 105 (6475/20 MHz) + - 107 (6485/40 MHz) + - 109 (6495/20 MHz) + - 111 (6505/160 MHz) + - 113 (6515/20 MHz) + - 115 (6525/40 MHz) + - 117 (6535/20 MHz) + - 119 (6545/80 MHz) + - 121 (6555/20 MHz) + - 123 (6565/40 MHz) + - 125 (6575/20 MHz) + - 129 (6595/20 MHz) + - 131 (6605/40 MHz) + - 133 (6615/20 MHz) + - 135 (6625/80 MHz) + - 137 (6635/20 MHz) + - 139 (6645/40 MHz) + - 141 (6655/20 MHz) + - 143 (6665/160 MHz) + - 145 (6675/20 MHz) + - 147 (6685/40 MHz) + - 149 (6695/20 MHz) + - 151 (6705/80 MHz) + - 153 (6715/20 MHz) + - 155 (6725/40 MHz) + - 157 (6735/20 MHz) + - 159 (6745/320 MHz) + - 161 (6755/20 MHz) + - 163 (6765/40 MHz) + - 165 (6775/20 MHz) + - 167 (6785/80 MHz) + - 169 (6795/20 MHz) + - 171 (6805/40 MHz) + - 173 (6815/20 MHz) + - 175 (6825/160 MHz) + - 177 (6835/20 MHz) + - 179 (6845/40 MHz) + - 181 (6855/20 MHz) + - 183 (6865/80 MHz) + - 185 (6875/20 MHz) + - 187 (6885/40 MHz) + - 189 (6895/20 MHz) + - 193 (6915/20 MHz) + - 195 (6925/40 MHz) + - 197 (6935/20 MHz) + - 199 (6945/80 MHz) + - 201 (6955/20 MHz) + - 203 (6965/40 MHz) + - 205 (6975/20 MHz) + - 207 (6985/160 MHz) + - 209 (6995/20 MHz) + - 211 (7005/40 MHz) + - 213 (7015/20 MHz) + - 215 (7025/80 MHz) + - 217 (7035/20 MHz) + - 219 (7045/40 MHz) + - 221 (7055/20 MHz) + - 225 (7075/20 MHz) + - 227 (7085/40 MHz) + - 229 (7095/20 MHz) + - 233 (7115/20 MHz) + - 1 (58.32/2.16 GHz) + - 2 (60.48/2.16 GHz) + - 3 (62.64/2.16 GHz) + - 4 (64.80/2.16 GHz) + - 5 (66.96/2.16 GHz) + - 6 (69.12/2.16 GHz) + - 9 (59.40/4.32 GHz) + - 10 (61.56/4.32 GHz) + - 11 (63.72/4.32 GHz) + - 12 (65.88/4.32 GHz) + - 13 (68.04/4.32 GHz) + - 17 (60.48/6.48 GHz) + - 18 (62.64/6.48 GHz) + - 19 (64.80/6.48 GHz) + - 20 (66.96/6.48 GHz) + - 25 (61.56/8.64 GHz) + - 26 (63.72/8.64 GHz) + - 27 (65.88/8.64 GHz) + poe_mode: + type: object + properties: + value: + enum: + - pd + - pse + - '' + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + label: + type: string + enum: + - PD + - PSE + poe_type: + type: object + properties: + value: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + label: + type: string + enum: + - 802.3af (Type 1) + - 802.3at (Type 2) + - 802.3bt (Type 3) + - 802.3bt (Type 4) + - Passive 24V (2-pair) + - Passive 24V (4-pair) + - Passive 48V (2-pair) + - Passive 48V (4-pair) + rf_channel_frequency: + type: number + format: double + maximum: 100000 + minimum: -100000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel frequency (MHz) + description: Populated by selected channel (if set) + rf_channel_width: + type: number + format: double + maximum: 10000 + minimum: -10000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel width (MHz) + description: Populated by selected channel (if set) + tx_power: + type: integer + maximum: 127 + minimum: -40 + nullable: true + title: Transmit power (dBm) + untagged_vlan: + allOf: + - $ref: '#/components/schemas/BriefVLAN' + nullable: true + tagged_vlans: + type: array + items: + $ref: '#/components/schemas/VLAN' + qinq_svlan: + allOf: + - $ref: '#/components/schemas/BriefVLAN' + nullable: true + vlan_translation_policy: + allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicy' + nullable: true + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + wireless_link: + allOf: + - $ref: '#/components/schemas/NestedWirelessLink' + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + wireless_lans: + type: array + items: + $ref: '#/components/schemas/WirelessLAN' + vrf: + allOf: + - $ref: '#/components/schemas/BriefVRF' + nullable: true + l2vpn_termination: + allOf: + - $ref: '#/components/schemas/BriefL2VPNTermination' + readOnly: true + nullable: true + connected_endpoints: + type: array + items: {} + nullable: true + readOnly: true + connected_endpoints_type: + type: string + readOnly: true + nullable: true + connected_endpoints_reachable: + type: boolean + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + count_ipaddresses: + type: integer + readOnly: true + count_fhrp_groups: + type: integer + readOnly: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - bridge_interfaces + - cable + - cable_end + - connected_endpoints + - connected_endpoints_reachable + - connected_endpoints_type + - count_fhrp_groups + - count_ipaddresses + - created + - device + - display + - display_url + - id + - l2vpn_termination + - last_updated + - link_peers + - link_peers_type + - mac_address + - mac_addresses + - name + - type + - url + - wireless_link + InterfaceRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + vdcs: + type: array + items: + type: integer + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + enabled: + type: boolean + parent: + allOf: + - $ref: '#/components/schemas/NestedInterfaceRequest' + nullable: true + bridge: + allOf: + - $ref: '#/components/schemas/NestedInterfaceRequest' + nullable: true + lag: + allOf: + - $ref: '#/components/schemas/NestedInterfaceRequest' + nullable: true + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + primary_mac_address: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefMACAddressRequest' + nullable: true + nullable: true + speed: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + title: Speed (Kbps) + duplex: + enum: + - half + - full + - auto + - '' + - null + type: string + description: |- + * `half` - Half + * `full` - Full + * `auto` - Auto + x-spec-enum-id: 368458a2b67c916b + nullable: true + wwn: + type: string + nullable: true + mgmt_only: + type: boolean + title: Management only + description: This interface is used only for out-of-band management + description: + type: string + maxLength: 200 + mode: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + type: string + description: |- + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + x-spec-enum-id: 84129b71b974ebe5 + rf_role: + enum: + - ap + - station + - '' + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + rf_channel: + enum: + - 2.4g-1-2412-22 + - 2.4g-2-2417-22 + - 2.4g-3-2422-22 + - 2.4g-4-2427-22 + - 2.4g-5-2432-22 + - 2.4g-6-2437-22 + - 2.4g-7-2442-22 + - 2.4g-8-2447-22 + - 2.4g-9-2452-22 + - 2.4g-10-2457-22 + - 2.4g-11-2462-22 + - 2.4g-12-2467-22 + - 2.4g-13-2472-22 + - 5g-32-5160-20 + - 5g-34-5170-40 + - 5g-36-5180-20 + - 5g-38-5190-40 + - 5g-40-5200-20 + - 5g-42-5210-80 + - 5g-44-5220-20 + - 5g-46-5230-40 + - 5g-48-5240-20 + - 5g-50-5250-160 + - 5g-52-5260-20 + - 5g-54-5270-40 + - 5g-56-5280-20 + - 5g-58-5290-80 + - 5g-60-5300-20 + - 5g-62-5310-40 + - 5g-64-5320-20 + - 5g-100-5500-20 + - 5g-102-5510-40 + - 5g-104-5520-20 + - 5g-106-5530-80 + - 5g-108-5540-20 + - 5g-110-5550-40 + - 5g-112-5560-20 + - 5g-114-5570-160 + - 5g-116-5580-20 + - 5g-118-5590-40 + - 5g-120-5600-20 + - 5g-122-5610-80 + - 5g-124-5620-20 + - 5g-126-5630-40 + - 5g-128-5640-20 + - 5g-132-5660-20 + - 5g-134-5670-40 + - 5g-136-5680-20 + - 5g-138-5690-80 + - 5g-140-5700-20 + - 5g-142-5710-40 + - 5g-144-5720-20 + - 5g-149-5745-20 + - 5g-151-5755-40 + - 5g-153-5765-20 + - 5g-155-5775-80 + - 5g-157-5785-20 + - 5g-159-5795-40 + - 5g-161-5805-20 + - 5g-163-5815-160 + - 5g-165-5825-20 + - 5g-167-5835-40 + - 5g-169-5845-20 + - 5g-171-5855-80 + - 5g-173-5865-20 + - 5g-175-5875-40 + - 5g-177-5885-20 + - 6g-1-5955-20 + - 6g-3-5965-40 + - 6g-5-5975-20 + - 6g-7-5985-80 + - 6g-9-5995-20 + - 6g-11-6005-40 + - 6g-13-6015-20 + - 6g-15-6025-160 + - 6g-17-6035-20 + - 6g-19-6045-40 + - 6g-21-6055-20 + - 6g-23-6065-80 + - 6g-25-6075-20 + - 6g-27-6085-40 + - 6g-29-6095-20 + - 6g-31-6105-320 + - 6g-33-6115-20 + - 6g-35-6125-40 + - 6g-37-6135-20 + - 6g-39-6145-80 + - 6g-41-6155-20 + - 6g-43-6165-40 + - 6g-45-6175-20 + - 6g-47-6185-160 + - 6g-49-6195-20 + - 6g-51-6205-40 + - 6g-53-6215-20 + - 6g-55-6225-80 + - 6g-57-6235-20 + - 6g-59-6245-40 + - 6g-61-6255-20 + - 6g-65-6275-20 + - 6g-67-6285-40 + - 6g-69-6295-20 + - 6g-71-6305-80 + - 6g-73-6315-20 + - 6g-75-6325-40 + - 6g-77-6335-20 + - 6g-79-6345-160 + - 6g-81-6355-20 + - 6g-83-6365-40 + - 6g-85-6375-20 + - 6g-87-6385-80 + - 6g-89-6395-20 + - 6g-91-6405-40 + - 6g-93-6415-20 + - 6g-95-6425-320 + - 6g-97-6435-20 + - 6g-99-6445-40 + - 6g-101-6455-20 + - 6g-103-6465-80 + - 6g-105-6475-20 + - 6g-107-6485-40 + - 6g-109-6495-20 + - 6g-111-6505-160 + - 6g-113-6515-20 + - 6g-115-6525-40 + - 6g-117-6535-20 + - 6g-119-6545-80 + - 6g-121-6555-20 + - 6g-123-6565-40 + - 6g-125-6575-20 + - 6g-129-6595-20 + - 6g-131-6605-40 + - 6g-133-6615-20 + - 6g-135-6625-80 + - 6g-137-6635-20 + - 6g-139-6645-40 + - 6g-141-6655-20 + - 6g-143-6665-160 + - 6g-145-6675-20 + - 6g-147-6685-40 + - 6g-149-6695-20 + - 6g-151-6705-80 + - 6g-153-6715-20 + - 6g-155-6725-40 + - 6g-157-6735-20 + - 6g-159-6745-320 + - 6g-161-6755-20 + - 6g-163-6765-40 + - 6g-165-6775-20 + - 6g-167-6785-80 + - 6g-169-6795-20 + - 6g-171-6805-40 + - 6g-173-6815-20 + - 6g-175-6825-160 + - 6g-177-6835-20 + - 6g-179-6845-40 + - 6g-181-6855-20 + - 6g-183-6865-80 + - 6g-185-6875-20 + - 6g-187-6885-40 + - 6g-189-6895-20 + - 6g-193-6915-20 + - 6g-195-6925-40 + - 6g-197-6935-20 + - 6g-199-6945-80 + - 6g-201-6955-20 + - 6g-203-6965-40 + - 6g-205-6975-20 + - 6g-207-6985-160 + - 6g-209-6995-20 + - 6g-211-7005-40 + - 6g-213-7015-20 + - 6g-215-7025-80 + - 6g-217-7035-20 + - 6g-219-7045-40 + - 6g-221-7055-20 + - 6g-225-7075-20 + - 6g-227-7085-40 + - 6g-229-7095-20 + - 6g-233-7115-20 + - 60g-1-58320-2160 + - 60g-2-60480-2160 + - 60g-3-62640-2160 + - 60g-4-64800-2160 + - 60g-5-66960-2160 + - 60g-6-69120-2160 + - 60g-9-59400-4320 + - 60g-10-61560-4320 + - 60g-11-63720-4320 + - 60g-12-65880-4320 + - 60g-13-68040-4320 + - 60g-17-60480-6480 + - 60g-18-62640-6480 + - 60g-19-64800-6480 + - 60g-20-66960-6480 + - 60g-25-61560-6480 + - 60g-26-63720-6480 + - 60g-27-65880-6480 + - '' + type: string + description: |- + * `2.4g-1-2412-22` - 1 (2412 MHz) + * `2.4g-2-2417-22` - 2 (2417 MHz) + * `2.4g-3-2422-22` - 3 (2422 MHz) + * `2.4g-4-2427-22` - 4 (2427 MHz) + * `2.4g-5-2432-22` - 5 (2432 MHz) + * `2.4g-6-2437-22` - 6 (2437 MHz) + * `2.4g-7-2442-22` - 7 (2442 MHz) + * `2.4g-8-2447-22` - 8 (2447 MHz) + * `2.4g-9-2452-22` - 9 (2452 MHz) + * `2.4g-10-2457-22` - 10 (2457 MHz) + * `2.4g-11-2462-22` - 11 (2462 MHz) + * `2.4g-12-2467-22` - 12 (2467 MHz) + * `2.4g-13-2472-22` - 13 (2472 MHz) + * `5g-32-5160-20` - 32 (5160/20 MHz) + * `5g-34-5170-40` - 34 (5170/40 MHz) + * `5g-36-5180-20` - 36 (5180/20 MHz) + * `5g-38-5190-40` - 38 (5190/40 MHz) + * `5g-40-5200-20` - 40 (5200/20 MHz) + * `5g-42-5210-80` - 42 (5210/80 MHz) + * `5g-44-5220-20` - 44 (5220/20 MHz) + * `5g-46-5230-40` - 46 (5230/40 MHz) + * `5g-48-5240-20` - 48 (5240/20 MHz) + * `5g-50-5250-160` - 50 (5250/160 MHz) + * `5g-52-5260-20` - 52 (5260/20 MHz) + * `5g-54-5270-40` - 54 (5270/40 MHz) + * `5g-56-5280-20` - 56 (5280/20 MHz) + * `5g-58-5290-80` - 58 (5290/80 MHz) + * `5g-60-5300-20` - 60 (5300/20 MHz) + * `5g-62-5310-40` - 62 (5310/40 MHz) + * `5g-64-5320-20` - 64 (5320/20 MHz) + * `5g-100-5500-20` - 100 (5500/20 MHz) + * `5g-102-5510-40` - 102 (5510/40 MHz) + * `5g-104-5520-20` - 104 (5520/20 MHz) + * `5g-106-5530-80` - 106 (5530/80 MHz) + * `5g-108-5540-20` - 108 (5540/20 MHz) + * `5g-110-5550-40` - 110 (5550/40 MHz) + * `5g-112-5560-20` - 112 (5560/20 MHz) + * `5g-114-5570-160` - 114 (5570/160 MHz) + * `5g-116-5580-20` - 116 (5580/20 MHz) + * `5g-118-5590-40` - 118 (5590/40 MHz) + * `5g-120-5600-20` - 120 (5600/20 MHz) + * `5g-122-5610-80` - 122 (5610/80 MHz) + * `5g-124-5620-20` - 124 (5620/20 MHz) + * `5g-126-5630-40` - 126 (5630/40 MHz) + * `5g-128-5640-20` - 128 (5640/20 MHz) + * `5g-132-5660-20` - 132 (5660/20 MHz) + * `5g-134-5670-40` - 134 (5670/40 MHz) + * `5g-136-5680-20` - 136 (5680/20 MHz) + * `5g-138-5690-80` - 138 (5690/80 MHz) + * `5g-140-5700-20` - 140 (5700/20 MHz) + * `5g-142-5710-40` - 142 (5710/40 MHz) + * `5g-144-5720-20` - 144 (5720/20 MHz) + * `5g-149-5745-20` - 149 (5745/20 MHz) + * `5g-151-5755-40` - 151 (5755/40 MHz) + * `5g-153-5765-20` - 153 (5765/20 MHz) + * `5g-155-5775-80` - 155 (5775/80 MHz) + * `5g-157-5785-20` - 157 (5785/20 MHz) + * `5g-159-5795-40` - 159 (5795/40 MHz) + * `5g-161-5805-20` - 161 (5805/20 MHz) + * `5g-163-5815-160` - 163 (5815/160 MHz) + * `5g-165-5825-20` - 165 (5825/20 MHz) + * `5g-167-5835-40` - 167 (5835/40 MHz) + * `5g-169-5845-20` - 169 (5845/20 MHz) + * `5g-171-5855-80` - 171 (5855/80 MHz) + * `5g-173-5865-20` - 173 (5865/20 MHz) + * `5g-175-5875-40` - 175 (5875/40 MHz) + * `5g-177-5885-20` - 177 (5885/20 MHz) + * `6g-1-5955-20` - 1 (5955/20 MHz) + * `6g-3-5965-40` - 3 (5965/40 MHz) + * `6g-5-5975-20` - 5 (5975/20 MHz) + * `6g-7-5985-80` - 7 (5985/80 MHz) + * `6g-9-5995-20` - 9 (5995/20 MHz) + * `6g-11-6005-40` - 11 (6005/40 MHz) + * `6g-13-6015-20` - 13 (6015/20 MHz) + * `6g-15-6025-160` - 15 (6025/160 MHz) + * `6g-17-6035-20` - 17 (6035/20 MHz) + * `6g-19-6045-40` - 19 (6045/40 MHz) + * `6g-21-6055-20` - 21 (6055/20 MHz) + * `6g-23-6065-80` - 23 (6065/80 MHz) + * `6g-25-6075-20` - 25 (6075/20 MHz) + * `6g-27-6085-40` - 27 (6085/40 MHz) + * `6g-29-6095-20` - 29 (6095/20 MHz) + * `6g-31-6105-320` - 31 (6105/320 MHz) + * `6g-33-6115-20` - 33 (6115/20 MHz) + * `6g-35-6125-40` - 35 (6125/40 MHz) + * `6g-37-6135-20` - 37 (6135/20 MHz) + * `6g-39-6145-80` - 39 (6145/80 MHz) + * `6g-41-6155-20` - 41 (6155/20 MHz) + * `6g-43-6165-40` - 43 (6165/40 MHz) + * `6g-45-6175-20` - 45 (6175/20 MHz) + * `6g-47-6185-160` - 47 (6185/160 MHz) + * `6g-49-6195-20` - 49 (6195/20 MHz) + * `6g-51-6205-40` - 51 (6205/40 MHz) + * `6g-53-6215-20` - 53 (6215/20 MHz) + * `6g-55-6225-80` - 55 (6225/80 MHz) + * `6g-57-6235-20` - 57 (6235/20 MHz) + * `6g-59-6245-40` - 59 (6245/40 MHz) + * `6g-61-6255-20` - 61 (6255/20 MHz) + * `6g-65-6275-20` - 65 (6275/20 MHz) + * `6g-67-6285-40` - 67 (6285/40 MHz) + * `6g-69-6295-20` - 69 (6295/20 MHz) + * `6g-71-6305-80` - 71 (6305/80 MHz) + * `6g-73-6315-20` - 73 (6315/20 MHz) + * `6g-75-6325-40` - 75 (6325/40 MHz) + * `6g-77-6335-20` - 77 (6335/20 MHz) + * `6g-79-6345-160` - 79 (6345/160 MHz) + * `6g-81-6355-20` - 81 (6355/20 MHz) + * `6g-83-6365-40` - 83 (6365/40 MHz) + * `6g-85-6375-20` - 85 (6375/20 MHz) + * `6g-87-6385-80` - 87 (6385/80 MHz) + * `6g-89-6395-20` - 89 (6395/20 MHz) + * `6g-91-6405-40` - 91 (6405/40 MHz) + * `6g-93-6415-20` - 93 (6415/20 MHz) + * `6g-95-6425-320` - 95 (6425/320 MHz) + * `6g-97-6435-20` - 97 (6435/20 MHz) + * `6g-99-6445-40` - 99 (6445/40 MHz) + * `6g-101-6455-20` - 101 (6455/20 MHz) + * `6g-103-6465-80` - 103 (6465/80 MHz) + * `6g-105-6475-20` - 105 (6475/20 MHz) + * `6g-107-6485-40` - 107 (6485/40 MHz) + * `6g-109-6495-20` - 109 (6495/20 MHz) + * `6g-111-6505-160` - 111 (6505/160 MHz) + * `6g-113-6515-20` - 113 (6515/20 MHz) + * `6g-115-6525-40` - 115 (6525/40 MHz) + * `6g-117-6535-20` - 117 (6535/20 MHz) + * `6g-119-6545-80` - 119 (6545/80 MHz) + * `6g-121-6555-20` - 121 (6555/20 MHz) + * `6g-123-6565-40` - 123 (6565/40 MHz) + * `6g-125-6575-20` - 125 (6575/20 MHz) + * `6g-129-6595-20` - 129 (6595/20 MHz) + * `6g-131-6605-40` - 131 (6605/40 MHz) + * `6g-133-6615-20` - 133 (6615/20 MHz) + * `6g-135-6625-80` - 135 (6625/80 MHz) + * `6g-137-6635-20` - 137 (6635/20 MHz) + * `6g-139-6645-40` - 139 (6645/40 MHz) + * `6g-141-6655-20` - 141 (6655/20 MHz) + * `6g-143-6665-160` - 143 (6665/160 MHz) + * `6g-145-6675-20` - 145 (6675/20 MHz) + * `6g-147-6685-40` - 147 (6685/40 MHz) + * `6g-149-6695-20` - 149 (6695/20 MHz) + * `6g-151-6705-80` - 151 (6705/80 MHz) + * `6g-153-6715-20` - 153 (6715/20 MHz) + * `6g-155-6725-40` - 155 (6725/40 MHz) + * `6g-157-6735-20` - 157 (6735/20 MHz) + * `6g-159-6745-320` - 159 (6745/320 MHz) + * `6g-161-6755-20` - 161 (6755/20 MHz) + * `6g-163-6765-40` - 163 (6765/40 MHz) + * `6g-165-6775-20` - 165 (6775/20 MHz) + * `6g-167-6785-80` - 167 (6785/80 MHz) + * `6g-169-6795-20` - 169 (6795/20 MHz) + * `6g-171-6805-40` - 171 (6805/40 MHz) + * `6g-173-6815-20` - 173 (6815/20 MHz) + * `6g-175-6825-160` - 175 (6825/160 MHz) + * `6g-177-6835-20` - 177 (6835/20 MHz) + * `6g-179-6845-40` - 179 (6845/40 MHz) + * `6g-181-6855-20` - 181 (6855/20 MHz) + * `6g-183-6865-80` - 183 (6865/80 MHz) + * `6g-185-6875-20` - 185 (6875/20 MHz) + * `6g-187-6885-40` - 187 (6885/40 MHz) + * `6g-189-6895-20` - 189 (6895/20 MHz) + * `6g-193-6915-20` - 193 (6915/20 MHz) + * `6g-195-6925-40` - 195 (6925/40 MHz) + * `6g-197-6935-20` - 197 (6935/20 MHz) + * `6g-199-6945-80` - 199 (6945/80 MHz) + * `6g-201-6955-20` - 201 (6955/20 MHz) + * `6g-203-6965-40` - 203 (6965/40 MHz) + * `6g-205-6975-20` - 205 (6975/20 MHz) + * `6g-207-6985-160` - 207 (6985/160 MHz) + * `6g-209-6995-20` - 209 (6995/20 MHz) + * `6g-211-7005-40` - 211 (7005/40 MHz) + * `6g-213-7015-20` - 213 (7015/20 MHz) + * `6g-215-7025-80` - 215 (7025/80 MHz) + * `6g-217-7035-20` - 217 (7035/20 MHz) + * `6g-219-7045-40` - 219 (7045/40 MHz) + * `6g-221-7055-20` - 221 (7055/20 MHz) + * `6g-225-7075-20` - 225 (7075/20 MHz) + * `6g-227-7085-40` - 227 (7085/40 MHz) + * `6g-229-7095-20` - 229 (7095/20 MHz) + * `6g-233-7115-20` - 233 (7115/20 MHz) + * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) + * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) + * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) + * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) + * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) + * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) + * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) + * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) + * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) + * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) + * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) + * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) + * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) + * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) + * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) + * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) + * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) + * `60g-27-65880-6480` - 27 (65.88/8.64 GHz) + x-spec-enum-id: 70cf66176c475063 + poe_mode: + enum: + - pd + - pse + - '' + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + poe_type: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + rf_channel_frequency: + type: number + format: double + maximum: 100000 + minimum: -100000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel frequency (MHz) + description: Populated by selected channel (if set) + rf_channel_width: + type: number + format: double + maximum: 10000 + minimum: -10000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel width (MHz) + description: Populated by selected channel (if set) + tx_power: + type: integer + maximum: 127 + minimum: -40 + nullable: true + title: Transmit power (dBm) + untagged_vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + tagged_vlans: + type: array + items: + type: integer + qinq_svlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + vlan_translation_policy: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' + nullable: true + nullable: true + mark_connected: + type: boolean + description: Treat as if a cable is connected + wireless_lans: + type: array + items: + type: integer + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - type + InterfaceTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + label: + type: string + enum: + - Virtual + - Bridge + - Link Aggregation Group (LAG) + - 100BASE-FX (10/100ME) + - 100BASE-LFX (10/100ME) + - 100BASE-TX (10/100ME) + - 100BASE-T1 (10/100ME) + - 1000BASE-BX10-D (1GE BiDi Down) + - 1000BASE-BX10-U (1GE BiDi Up) + - 1000BASE-CWDM (1GE) + - 1000BASE-CX (1GE DAC) + - 1000BASE-DWDM (1GE) + - 1000BASE-EX (1GE) + - 1000BASE-LSX (1GE) + - 1000BASE-LX (1GE) + - 1000BASE-LX10/LH (1GE) + - 1000BASE-SX (1GE) + - 1000BASE-T (1GE) + - 1000BASE-TX (1GE) + - 1000BASE-ZX (1GE) + - 2.5GBASE-T (2.5GE) + - 5GBASE-T (5GE) + - 10GBASE-BR-D (10GE BiDi Down) + - 10GBASE-BR-U (10GE BiDi Up) + - 10GBASE-CU (10GE DAC Passive Twinax) + - 10GBASE-CX4 (10GE DAC) + - 10GBASE-ER (10GE) + - 10GBASE-LR (10GE) + - 10GBASE-LRM (10GE) + - 10GBASE-LX4 (10GE) + - 10GBASE-SR (10GE) + - 10GBASE-T (10GE) + - 10GBASE-ZR (10GE) + - 25GBASE-CR (25GE DAC) + - 25GBASE-ER (25GE) + - 25GBASE-LR (25GE) + - 25GBASE-SR (25GE) + - 25GBASE-T (25GE) + - 40GBASE-CR4 (40GE DAC) + - 40GBASE-ER4 (40GE) + - 40GBASE-FR4 (40GE) + - 40GBASE-LR4 (40GE) + - 40GBASE-SR4 (40GE) + - 40GBASE-SR4 (40GE BiDi) + - 50GBASE-CR (50GE DAC) + - 50GBASE-ER (50GE) + - 50GBASE-FR (50GE) + - 50GBASE-LR (50GE) + - 50GBASE-SR (50GE) + - 100GBASE-CR1 (100GE DAC) + - 100GBASE-CR2 (100GE DAC) + - 100GBASE-CR4 (100GE DAC) + - 100GBASE-CR10 (100GE DAC) + - 100GBASE-CWDM4 (100GE) + - 100GBASE-DR (100GE) + - 100GBASE-ER4 (100GE) + - 100GBASE-FR1 (100GE) + - 100GBASE-LR1 (100GE) + - 100GBASE-LR4 (100GE) + - 100GBASE-SR1 (100GE) + - 100GBASE-SR1.2 (100GE BiDi) + - 100GBASE-SR2 (100GE) + - 100GBASE-SR4 (100GE) + - 100GBASE-SR10 (100GE) + - 100GBASE-ZR (100GE) + - 200GBASE-CR2 (200GE) + - 200GBASE-CR4 (200GE) + - 200GBASE-DR4 (200GE) + - 200GBASE-ER4 (200GE) + - 200GBASE-FR4 (200GE) + - 200GBASE-LR4 (200GE) + - 200GBASE-SR2 (200GE) + - 200GBASE-SR4 (200GE) + - 200GBASE-VR2 (200GE) + - 400GBASE-CR4 (400GE) + - 400GBASE-DR4 (400GE) + - 400GBASE-ER8 (400GE) + - 400GBASE-FR4 (400GE) + - 400GBASE-FR8 (400GE) + - 400GBASE-LR4 (400GE) + - 400GBASE-LR8 (400GE) + - 400GBASE-SR4 (400GE) + - 400GBASE-SR4.2 (400GE BiDi) + - 400GBASE-SR8 (400GE) + - 400GBASE-SR16 (400GE) + - 400GBASE-VR4 (400GE) + - 400GBASE-ZR (400GE) + - 800GBASE-CR8 (800GE) + - 800GBASE-DR8 (800GE) + - 800GBASE-SR8 (800GE) + - 800GBASE-VR8 (800GE) + - 1.6TBASE-CR8 (1.6TE) + - 1.6TBASE-DR8 (1.6TE) + - 1.6TBASE-DR8-2 (1.6TE) + - SFP (100ME) + - GBIC (1GE) + - SFP (1GE) + - SFP (2.5GE) + - SFP+ (10GE) + - XENPAK (10GE) + - XFP (10GE) + - X2 (10GE) + - SFP28 (25GE) + - QSFP+ (40GE) + - QSFP28 (50GE) + - SFP56 (50GE) + - CFP (100GE) + - CFP2 (100GE) + - CFP4 (100GE) + - CXP (100GE) + - Cisco CPAK (100GE) + - DSFP (100GE) + - QSFP28 (100GE) + - QSFP-DD (100GE) + - SFP-DD (100GE) + - CFP2 (200GE) + - QSFP56 (200GE) + - QSFP-DD (200GE) + - QSFP112 (400GE) + - QSFP-DD (400GE) + - CDFP (400GE) + - CFP2 (400GE) + - CPF8 (400GE) + - OSFP (400GE) + - OSFP-RHS (400GE) + - OSFP (800GE) + - QSFP-DD (800GE) + - OSFP1600 (1.6TE) + - OSFP1600-RHS (1.6TE) + - QSFP-DD1600 (1.6TE) + - 1000BASE-KX (1GE) + - 2.5GBASE-KX (2.5GE) + - 5GBASE-KR (5GE) + - 10GBASE-KR (10GE) + - 10GBASE-KX4 (10GE) + - 25GBASE-KR (25GE) + - 40GBASE-KR4 (40GE) + - 50GBASE-KR (50GE) + - 100GBASE-KP4 (100GE) + - 100GBASE-KR2 (100GE) + - 100GBASE-KR4 (100GE) + - 1.6TBASE-KR8 (1.6TE) + - IEEE 802.11a + - IEEE 802.11b/g + - IEEE 802.11n (Wi-Fi 4) + - IEEE 802.11ac (Wi-Fi 5) + - IEEE 802.11ad (WiGig) + - IEEE 802.11ax (Wi-Fi 6) + - IEEE 802.11ay (WiGig) + - IEEE 802.11be (Wi-Fi 7) + - IEEE 802.15.1 (Bluetooth) + - IEEE 802.15.4 (LR-WPAN) + - Other (Wireless) + - GSM + - CDMA + - LTE + - 4G + - 5G + - OC-3/STM-1 + - OC-12/STM-4 + - OC-48/STM-16 + - OC-192/STM-64 + - OC-768/STM-256 + - OC-1920/STM-640 + - OC-3840/STM-1234 + - SFP (1GFC) + - SFP (2GFC) + - SFP (4GFC) + - SFP+ (8GFC) + - SFP+ (16GFC) + - SFP28 (32GFC) + - SFP+ (32GFC) + - QSFP+ (64GFC) + - SFP-DD (64GFC) + - SFP+ (64GFC) + - QSFP28 (128GFC) + - SDR (2 Gbps) + - DDR (4 Gbps) + - QDR (8 Gbps) + - FDR10 (10 Gbps) + - FDR (13.5 Gbps) + - EDR (25 Gbps) + - HDR (50 Gbps) + - NDR (100 Gbps) + - XDR (250 Gbps) + - T1 (1.544 Mbps) + - E1 (2.048 Mbps) + - T3 (45 Mbps) + - E3 (34 Mbps) + - xDSL + - DOCSIS + - MoCA + - BPON (622 Mbps / 155 Mbps) + - EPON (1 Gbps) + - 10G-EPON (10 Gbps) + - GPON (2.5 Gbps / 1.25 Gbps) + - XG-PON (10 Gbps / 2.5 Gbps) + - XGS-PON (10 Gbps) + - NG-PON2 (TWDM-PON) (4x10 Gbps) + - 25G-PON (25 Gbps) + - 50G-PON (50 Gbps) + - Cisco StackWise + - Cisco StackWise Plus + - Cisco FlexStack + - Cisco FlexStack Plus + - Cisco StackWise-80 + - Cisco StackWise-160 + - Cisco StackWise-320 + - Cisco StackWise-480 + - Cisco StackWise-1T + - Juniper VCP + - Extreme SummitStack + - Extreme SummitStack-128 + - Extreme SummitStack-256 + - Extreme SummitStack-512 + - Other + enabled: + type: boolean + mgmt_only: + type: boolean + title: Management only + description: + type: string + maxLength: 200 + bridge: + allOf: + - $ref: '#/components/schemas/NestedInterfaceTemplate' + nullable: true + poe_mode: + type: object + properties: + value: + enum: + - pd + - pse + - '' + - null + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + label: + type: string + enum: + - PD + - PSE + nullable: true + poe_type: + type: object + properties: + value: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + - null + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + label: + type: string + enum: + - 802.3af (Type 1) + - 802.3at (Type 2) + - 802.3bt (Type 3) + - 802.3bt (Type 4) + - Passive 24V (2-pair) + - Passive 24V (4-pair) + - Passive 48V (2-pair) + - Passive 48V (4-pair) + nullable: true + rf_role: + type: object + properties: + value: + enum: + - ap + - station + - '' + - null + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + label: + type: string + enum: + - Access point + - Station + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - type + - url + InterfaceTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + enabled: + type: boolean + mgmt_only: + type: boolean + title: Management only + description: + type: string + maxLength: 200 + bridge: + allOf: + - $ref: '#/components/schemas/NestedInterfaceTemplateRequest' + nullable: true + poe_mode: + enum: + - pd + - pse + - '' + - null + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + poe_type: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + - null + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + nullable: true + rf_role: + enum: + - ap + - station + - '' + - null + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + required: + - name + - type + InventoryItem: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + parent: + type: integer + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + status: + type: object + properties: + value: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + label: + type: string + enum: + - Offline + - Active + - Planned + - Staged + - Failed + - Decommissioning + role: + allOf: + - $ref: '#/components/schemas/BriefInventoryItemRole' + nullable: true + manufacturer: + allOf: + - $ref: '#/components/schemas/BriefManufacturer' + nullable: true + part_id: + type: string + description: Manufacturer-assigned part identifier + maxLength: 50 + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this item + maxLength: 50 + discovered: + type: boolean + description: This item was automatically discovered + description: + type: string + maxLength: 200 + component_type: + type: string + nullable: true + component_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + component: + readOnly: true + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - component + - created + - device + - display + - display_url + - id + - last_updated + - name + - url + InventoryItemRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + parent: + type: integer + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + part_id: + type: string + description: Manufacturer-assigned part identifier + maxLength: 50 + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this item + maxLength: 50 + discovered: + type: boolean + description: This item was automatically discovered + description: + type: string + maxLength: 200 + component_type: + type: string + nullable: true + component_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + InventoryItemRole: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + inventoryitem_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - id + - inventoryitem_count + - last_updated + - name + - slug + - url + InventoryItemRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + InventoryItemTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + $ref: '#/components/schemas/BriefDeviceType' + parent: + type: integer + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + role: + allOf: + - $ref: '#/components/schemas/BriefInventoryItemRole' + nullable: true + manufacturer: + allOf: + - $ref: '#/components/schemas/BriefManufacturer' + nullable: true + part_id: + type: string + description: Manufacturer-assigned part identifier + maxLength: 50 + description: + type: string + maxLength: 200 + component_type: + type: string + nullable: true + component_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + component: + readOnly: true + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - component + - created + - device_type + - display + - id + - last_updated + - name + - url + InventoryItemTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + parent: + type: integer + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + part_id: + type: string + description: Manufacturer-assigned part identifier + maxLength: 50 + description: + type: string + maxLength: 200 + component_type: + type: string + nullable: true + component_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + required: + - device_type + - name + Job: + type: object + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + readOnly: true + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + object: + nullable: true + readOnly: true + name: + type: string + maxLength: 200 + status: + type: object + properties: + value: + enum: + - pending + - scheduled + - running + - completed + - errored + - failed + type: string + description: |- + * `pending` - Pending + * `scheduled` - Scheduled + * `running` - Running + * `completed` - Completed + * `errored` - Errored + * `failed` - Failed + x-spec-enum-id: b3049df95b935eab + label: + type: string + enum: + - Pending + - Scheduled + - Running + - Completed + - Errored + - Failed + readOnly: true + created: + type: string + format: date-time + readOnly: true + scheduled: + type: string + format: date-time + nullable: true + interval: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Recurrence interval (in minutes) + started: + type: string + format: date-time + nullable: true + completed: + type: string + format: date-time + nullable: true + user: + allOf: + - $ref: '#/components/schemas/BriefUser' + readOnly: true + data: + nullable: true + error: + type: string + readOnly: true + job_id: + type: string + format: uuid + queue_name: + type: string + description: Name of the queue in which this job was enqueued + maxLength: 100 + notifications: + type: object + properties: + value: + enum: + - always + - on_failure + - never + type: string + description: |- + * `always` - Always + * `on_failure` - On failure + * `never` - Never + x-spec-enum-id: 57071f4400340a5c + label: + type: string + enum: + - Always + - On failure + - Never + readOnly: true + log_entries: + type: array + items: {} + required: + - created + - display + - display_url + - error + - id + - job_id + - name + - notifications + - object + - object_type + - status + - url + - user + JournalEntry: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + assigned_object_type: + type: string + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + assigned_object: + readOnly: true + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + created_by: + type: integer + nullable: true + kind: + type: object + properties: + value: + enum: + - info + - success + - warning + - danger + type: string + description: |- + * `info` - Info + * `success` - Success + * `warning` - Warning + * `danger` - Danger + x-spec-enum-id: 6f65abe0aab2c78c + label: + type: string + enum: + - Info + - Success + - Warning + - Danger + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - assigned_object + - assigned_object_id + - assigned_object_type + - comments + - created + - display + - display_url + - id + - last_updated + - url + JournalEntryRequest: + type: object + description: Adds support for custom fields and tags. + properties: + assigned_object_type: + type: string + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + created_by: + type: integer + nullable: true + kind: + enum: + - info + - success + - warning + - danger + type: string + description: |- + * `info` - Info + * `success` - Success + * `warning` - Warning + * `danger` - Danger + x-spec-enum-id: 6f65abe0aab2c78c + comments: + type: string + minLength: 1 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - assigned_object_id + - assigned_object_type + - comments + L2VPN: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + identifier: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + type: + type: object + properties: + value: + enum: + - vpws + - vpls + - vxlan + - vxlan-evpn + - mpls-evpn + - pbb-evpn + - evpn-vpws + - epl + - evpl + - ep-lan + - evp-lan + - ep-tree + - evp-tree + - spb + type: string + description: |- + * `vpws` - VPWS + * `vpls` - VPLS + * `vxlan` - VXLAN + * `vxlan-evpn` - VXLAN-EVPN + * `mpls-evpn` - MPLS EVPN + * `pbb-evpn` - PBB EVPN + * `evpn-vpws` - EVPN VPWS + * `epl` - EPL + * `evpl` - EVPL + * `ep-lan` - Ethernet Private LAN + * `evp-lan` - Ethernet Virtual Private LAN + * `ep-tree` - Ethernet Private Tree + * `evp-tree` - Ethernet Virtual Private Tree + * `spb` - SPB + x-spec-enum-id: 0a46f8056d717efc + label: + type: string + enum: + - VPWS + - VPLS + - VXLAN + - VXLAN-EVPN + - MPLS EVPN + - PBB EVPN + - EVPN VPWS + - EPL + - EVPL + - Ethernet Private LAN + - Ethernet Virtual Private LAN + - Ethernet Private Tree + - Ethernet Virtual Private Tree + - SPB + status: + type: object + properties: + value: + enum: + - active + - planned + - decommissioning + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 8b9dc8efc7c3d5b0 + label: + type: string + enum: + - Active + - Planned + - Decommissioning + import_targets: + type: array + items: + $ref: '#/components/schemas/RouteTarget' + export_targets: + type: array + items: + $ref: '#/components/schemas/RouteTarget' + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + L2VPNRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + identifier: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + type: + enum: + - vpws + - vpls + - vxlan + - vxlan-evpn + - mpls-evpn + - pbb-evpn + - evpn-vpws + - epl + - evpl + - ep-lan + - evp-lan + - ep-tree + - evp-tree + - spb + type: string + description: |- + * `vpws` - VPWS + * `vpls` - VPLS + * `vxlan` - VXLAN + * `vxlan-evpn` - VXLAN-EVPN + * `mpls-evpn` - MPLS EVPN + * `pbb-evpn` - PBB EVPN + * `evpn-vpws` - EVPN VPWS + * `epl` - EPL + * `evpl` - EVPL + * `ep-lan` - Ethernet Private LAN + * `evp-lan` - Ethernet Virtual Private LAN + * `ep-tree` - Ethernet Private Tree + * `evp-tree` - Ethernet Virtual Private Tree + * `spb` - SPB + x-spec-enum-id: 0a46f8056d717efc + status: + enum: + - active + - planned + - decommissioning + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 8b9dc8efc7c3d5b0 + import_targets: + type: array + items: + type: integer + export_targets: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + L2VPNTermination: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + l2vpn: + $ref: '#/components/schemas/BriefL2VPN' + assigned_object_type: + type: string + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + assigned_object: + readOnly: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - assigned_object + - assigned_object_id + - assigned_object_type + - created + - display + - display_url + - id + - l2vpn + - last_updated + - url + L2VPNTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + l2vpn: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefL2VPNRequest' + assigned_object_type: + type: string + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - assigned_object_id + - assigned_object_type + - l2vpn + Location: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + site: + $ref: '#/components/schemas/BriefSite' + parent: + allOf: + - $ref: '#/components/schemas/NestedLocation' + nullable: true + status: + type: object + properties: + value: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + label: + type: string + enum: + - Planned + - Staging + - Active + - Decommissioning + - Retired + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + rack_count: + type: integer + readOnly: true + default: 0 + device_count: + type: integer + readOnly: true + default: 0 + prefix_count: + type: integer + format: int64 + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - created + - device_count + - display + - display_url + - id + - last_updated + - name + - prefix_count + - rack_count + - site + - slug + - url + LocationRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + parent: + allOf: + - $ref: '#/components/schemas/NestedLocationRequest' + nullable: true + status: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - site + - slug + MACAddress: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + mac_address: + type: string + assigned_object_type: + type: string + nullable: true + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + assigned_object: + readOnly: true + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - assigned_object + - created + - display + - display_url + - id + - last_updated + - mac_address + - url + MACAddressRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + mac_address: + type: string + minLength: 1 + assigned_object_type: + type: string + nullable: true + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - mac_address + Manufacturer: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + devicetype_count: + type: integer + format: int64 + readOnly: true + moduletype_count: + type: integer + format: int64 + readOnly: true + inventoryitem_count: + type: integer + format: int64 + readOnly: true + platform_count: + type: integer + format: int64 + readOnly: true + required: + - created + - devicetype_count + - display + - display_url + - id + - inventoryitem_count + - last_updated + - moduletype_count + - name + - platform_count + - slug + - url + ManufacturerRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + Module: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module_bay: + $ref: '#/components/schemas/NestedModuleBay' + module_type: + $ref: '#/components/schemas/BriefModuleType' + status: + type: object + properties: + value: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + label: + type: string + enum: + - Offline + - Active + - Planned + - Staged + - Failed + - Decommissioning + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - device + - display + - display_url + - id + - last_updated + - module_bay + - module_type + - url + ModuleBay: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + position: + type: string + description: Identifier to reference when renaming installed components + maxLength: 30 + enabled: + type: boolean + description: + type: string + maxLength: 200 + installed_module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - created + - device + - display + - display_url + - id + - last_updated + - name + - url + ModuleBayRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + position: + type: string + description: Identifier to reference when renaming installed components + maxLength: 30 + enabled: + type: boolean + description: + type: string + maxLength: 200 + installed_module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + ModuleBayTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + position: + type: string + description: Identifier to reference when renaming installed components + maxLength: 30 + enabled: + type: boolean + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - url + ModuleBayTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + position: + type: string + description: Identifier to reference when renaming installed components + maxLength: 30 + enabled: + type: boolean + description: + type: string + maxLength: 200 + required: + - name + ModuleRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module_bay: + $ref: '#/components/schemas/NestedModuleBayRequest' + module_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefModuleTypeRequest' + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + replicate_components: + type: boolean + writeOnly: true + default: true + description: 'Automatically populate components associated with this module + type (default: true)' + adopt_components: + type: boolean + writeOnly: true + default: false + description: Adopt already existing components + required: + - device + - module_bay + - module_type + ModuleType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + profile: + allOf: + - $ref: '#/components/schemas/BriefModuleTypeProfile' + nullable: true + manufacturer: + $ref: '#/components/schemas/BriefManufacturer' + model: + type: string + maxLength: 100 + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + airflow: + type: object + properties: + value: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - passive + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `passive` - Passive + x-spec-enum-id: 5ad4e700c656b09d + label: + type: string + enum: + - Front to rear + - Rear to front + - Left to right + - Right to left + - Side to rear + - Passive + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + type: object + properties: + value: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + label: + type: string + enum: + - Kilograms + - Grams + - Pounds + - Ounces + nullable: true + description: + type: string + maxLength: 200 + attributes: + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + module_count: + type: integer + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - manufacturer + - model + - module_count + - url + ModuleTypeProfile: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + schema: + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - url + ModuleTypeProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + schema: + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + ModuleTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - passive + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `passive` - Passive + x-spec-enum-id: 5ad4e700c656b09d + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + description: + type: string + maxLength: 200 + attributes: + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - manufacturer + - model + NestedContactGroup: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - display_url + - id + - name + - slug + - url + NestedContactGroupRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + required: + - name + - slug + NestedDevice: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + nullable: true + maxLength: 64 + required: + - display + - display_url + - id + - url + NestedDeviceRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + nullable: true + maxLength: 64 + NestedDeviceRole: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + required: + - display + - display_url + - id + - name + - url + NestedDeviceRoleRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + required: + - name + NestedGroup: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 150 + required: + - display + - display_url + - id + - name + - url + NestedIPAddress: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + family: + type: integer + readOnly: true + address: + type: string + required: + - address + - display + - display_url + - family + - id + - url + NestedIPAddressRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + address: + type: string + minLength: 1 + required: + - address + NestedInterface: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + allOf: + - $ref: '#/components/schemas/NestedDevice' + readOnly: true + name: + type: string + maxLength: 64 + cable: + type: integer + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - device + - display + - display_url + - id + - name + - url + NestedInterfaceRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + cable: + type: integer + nullable: true + required: + - name + NestedInterfaceTemplate: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + required: + - display + - id + - name + - url + NestedInterfaceTemplateRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + required: + - name + NestedLocation: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - display_url + - id + - name + - slug + - url + NestedLocationRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + required: + - name + - slug + NestedModuleBay: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 64 + required: + - display + - display_url + - id + - name + - url + NestedModuleBayRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + required: + - name + NestedPlatform: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + required: + - display + - display_url + - id + - name + - url + NestedPlatformRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + required: + - name + NestedProviderAccount: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + account: + type: string + title: Account ID + maxLength: 100 + required: + - account + - display + - display_url + - id + - url + NestedRegion: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - display_url + - id + - name + - slug + - url + NestedRegionRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + required: + - name + - slug + NestedSiteGroup: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - display_url + - id + - name + - slug + - url + NestedSiteGroupRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + required: + - name + - slug + NestedTag: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + pattern: ^[-\w]+$ + maxLength: 100 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + required: + - display + - display_url + - id + - name + - slug + - url + NestedTagRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + pattern: ^[-\w]+$ + maxLength: 100 + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + required: + - name + - slug + NestedTenantGroup: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - display_url + - id + - name + - slug + - url + NestedTenantGroupRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + required: + - name + - slug + NestedUser: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + username: + type: string + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + pattern: ^[\w.@+-]+$ + maxLength: 150 + required: + - display + - display_url + - id + - url + - username + NestedVLAN: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - display + - id + - name + - url + - vid + NestedVLANRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + maxLength: 200 + required: + - name + - vid + NestedVMInterface: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + virtual_machine: + allOf: + - $ref: '#/components/schemas/NestedVirtualMachine' + readOnly: true + name: + type: string + maxLength: 64 + required: + - display + - display_url + - id + - name + - url + - virtual_machine + NestedVMInterfaceRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + required: + - name + NestedVirtualMachine: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 64 + required: + - display + - display_url + - id + - name + - url + NestedVirtualMachineRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + required: + - name + NestedWirelessLANGroup: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - display + - display_url + - id + - name + - slug + - url + NestedWirelessLANGroupRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + required: + - name + - slug + NestedWirelessLink: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + ssid: + type: string + maxLength: 32 + required: + - display + - display_url + - id + - url + NestedWirelessLinkRequest: + type: object + description: |- + Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a + dictionary of attributes which can be used to uniquely identify the related object. This class should be + subclassed to return a full representation of the related object on read. + properties: + ssid: + type: string + maxLength: 32 + Notification: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + object: + readOnly: true + nullable: true + user: + $ref: '#/components/schemas/BriefUser' + created: + type: string + format: date-time + readOnly: true + read: + type: string + format: date-time + nullable: true + event_type: + enum: + - object_created + - object_updated + - object_deleted + - job_started + - job_completed + - job_failed + - job_errored + type: string + description: |- + * `object_created` - Object created + * `object_updated` - Object updated + * `object_deleted` - Object deleted + * `job_started` - Job started + * `job_completed` - Job completed + * `job_failed` - Job failed + * `job_errored` - Job errored + x-spec-enum-id: 01e557313a5c7bd2 + title: Event + required: + - created + - display + - event_type + - id + - object + - object_id + - object_type + - url + - user + NotificationGroup: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + display_url: + type: string + format: uri + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + groups: + type: array + items: + $ref: '#/components/schemas/Group' + users: + type: array + items: + $ref: '#/components/schemas/User' + required: + - display + - display_url + - id + - name + - url + NotificationGroupRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + groups: + type: array + items: + type: integer + users: + type: array + items: + type: integer + required: + - name + NotificationRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + read: + type: string + format: date-time + nullable: true + event_type: + enum: + - object_created + - object_updated + - object_deleted + - job_started + - job_completed + - job_failed + - job_errored + type: string + description: |- + * `object_created` - Object created + * `object_updated` - Object updated + * `object_deleted` - Object deleted + * `job_started` - Job started + * `job_completed` - Job completed + * `job_failed` - Job failed + * `job_errored` - Job errored + x-spec-enum-id: 01e557313a5c7bd2 + title: Event + required: + - event_type + - object_id + - object_type + - user + ObjectChange: + type: object + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + time: + type: string + format: date-time + readOnly: true + user: + allOf: + - $ref: '#/components/schemas/BriefUser' + readOnly: true + user_name: + type: string + readOnly: true + request_id: + type: string + format: uuid + readOnly: true + action: + type: object + properties: + value: + enum: + - create + - update + - delete + type: string + description: |- + * `create` - Created + * `update` - Updated + * `delete` - Deleted + x-spec-enum-id: 36ce3d432464454d + label: + type: string + enum: + - Created + - Updated + - Deleted + readOnly: true + changed_object_type: + type: string + readOnly: true + changed_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + changed_object: + readOnly: true + nullable: true + object_repr: + type: string + readOnly: true + message: + type: string + readOnly: true + prechange_data: + readOnly: true + nullable: true + postchange_data: + readOnly: true + nullable: true + required: + - action + - changed_object + - changed_object_id + - changed_object_type + - display + - display_url + - id + - message + - object_repr + - postchange_data + - prechange_data + - request_id + - time + - url + - user + - user_name + ObjectPermission: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + enabled: + type: boolean + object_types: + type: array + items: + type: string + actions: + type: array + items: + type: string + maxLength: 30 + description: The list of actions granted by this permission + constraints: + nullable: true + description: Queryset filter matching the applicable objects of the selected + type(s) + groups: + type: array + items: + $ref: '#/components/schemas/NestedGroup' + users: + type: array + items: + $ref: '#/components/schemas/NestedUser' + required: + - actions + - display + - display_url + - id + - name + - object_types + - url + ObjectPermissionRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + enabled: + type: boolean + object_types: + type: array + items: + type: string + actions: + type: array + items: + type: string + minLength: 1 + maxLength: 30 + description: The list of actions granted by this permission + constraints: + nullable: true + description: Queryset filter matching the applicable objects of the selected + type(s) + groups: + type: array + items: + type: integer + users: + type: array + items: + type: integer + required: + - actions + - name + - object_types + ObjectType: + type: object + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + app_label: + type: string + maxLength: 100 + app_name: + type: string + readOnly: true + model: + type: string + title: Python model class name + maxLength: 100 + model_name: + type: string + readOnly: true + model_name_plural: + type: string + readOnly: true + public: + type: boolean + readOnly: true + features: + type: array + items: + type: string + maxLength: 50 + readOnly: true + is_plugin_model: + type: boolean + readOnly: true + rest_api_endpoint: + type: string + readOnly: true + description: + type: string + readOnly: true + required: + - app_label + - app_name + - description + - display + - features + - id + - is_plugin_model + - model + - model_name + - model_name_plural + - public + - rest_api_endpoint + - url + Owner: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + group: + allOf: + - $ref: '#/components/schemas/BriefOwnerGroup' + nullable: true + description: + type: string + maxLength: 200 + user_groups: + type: array + items: + $ref: '#/components/schemas/Group' + users: + type: array + items: + $ref: '#/components/schemas/User' + required: + - display + - display_url + - group + - id + - name + - url + OwnerGroup: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + member_count: + type: integer + format: int64 + readOnly: true + required: + - display + - display_url + - id + - member_count + - name + - url + OwnerGroupRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + required: + - name + OwnerRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerGroupRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + user_groups: + type: array + items: + type: integer + users: + type: array + items: + type: integer + required: + - group + - name + PaginatedASNList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ASN' + PaginatedASNRangeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ASNRange' + PaginatedAggregateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Aggregate' + PaginatedBookmarkList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Bookmark' + PaginatedCableBundleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CableBundle' + PaginatedCableList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Cable' + PaginatedCableTerminationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CableTermination' + PaginatedCircuitGroupAssignmentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CircuitGroupAssignment' + PaginatedCircuitGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CircuitGroup' + PaginatedCircuitList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Circuit' + PaginatedCircuitTerminationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CircuitTermination' + PaginatedCircuitTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CircuitType' + PaginatedClusterGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ClusterGroup' + PaginatedClusterList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Cluster' + PaginatedClusterTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ClusterType' + PaginatedConfigContextList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConfigContext' + PaginatedConfigContextProfileList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConfigContextProfile' + PaginatedConfigTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConfigTemplate' + PaginatedConsolePortList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConsolePort' + PaginatedConsolePortTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConsolePortTemplate' + PaginatedConsoleServerPortList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPort' + PaginatedConsoleServerPortTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConsoleServerPortTemplate' + PaginatedContactAssignmentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ContactAssignment' + PaginatedContactGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ContactGroup' + PaginatedContactList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Contact' + PaginatedContactRoleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ContactRole' + PaginatedCustomFieldChoiceSetList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CustomFieldChoiceSet' + PaginatedCustomFieldList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CustomField' + PaginatedCustomLinkList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/CustomLink' + PaginatedDataFileList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/DataFile' + PaginatedDataSourceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/DataSource' + PaginatedDeviceBayList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/DeviceBay' + PaginatedDeviceBayTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/DeviceBayTemplate' + PaginatedDeviceRoleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/DeviceRole' + PaginatedDeviceTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/DeviceType' + PaginatedDeviceWithConfigContextList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/DeviceWithConfigContext' + PaginatedEventRuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/EventRule' + PaginatedExportTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ExportTemplate' + PaginatedFHRPGroupAssignmentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/FHRPGroupAssignment' + PaginatedFHRPGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/FHRPGroup' + PaginatedFrontPortList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/FrontPort' + PaginatedFrontPortTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplate' + PaginatedGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Group' + PaginatedIKEPolicyList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/IKEPolicy' + PaginatedIKEProposalList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/IKEProposal' + PaginatedIPAddressList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/IPAddress' + PaginatedIPRangeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/IPRange' + PaginatedIPSecPolicyList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/IPSecPolicy' + PaginatedIPSecProfileList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/IPSecProfile' + PaginatedIPSecProposalList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/IPSecProposal' + PaginatedImageAttachmentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ImageAttachment' + PaginatedInterfaceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Interface' + PaginatedInterfaceTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/InterfaceTemplate' + PaginatedInventoryItemList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/InventoryItem' + PaginatedInventoryItemRoleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/InventoryItemRole' + PaginatedInventoryItemTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/InventoryItemTemplate' + PaginatedJobList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Job' + PaginatedJournalEntryList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/JournalEntry' + PaginatedL2VPNList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/L2VPN' + PaginatedL2VPNTerminationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/L2VPNTermination' + PaginatedLocationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Location' + PaginatedMACAddressList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/MACAddress' + PaginatedManufacturerList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Manufacturer' + PaginatedModuleBayList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleBay' + PaginatedModuleBayTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleBayTemplate' + PaginatedModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Module' + PaginatedModuleTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleType' + PaginatedModuleTypeProfileList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleTypeProfile' + PaginatedNotificationGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NotificationGroup' + PaginatedNotificationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Notification' + PaginatedObjectChangeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ObjectChange' + PaginatedObjectPermissionList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ObjectPermission' + PaginatedObjectTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ObjectType' + PaginatedOwnerGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/OwnerGroup' + PaginatedOwnerList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Owner' + PaginatedPlatformList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Platform' + PaginatedPowerFeedList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PowerFeed' + PaginatedPowerOutletList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PowerOutlet' + PaginatedPowerOutletTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PowerOutletTemplate' + PaginatedPowerPanelList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PowerPanel' + PaginatedPowerPortList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PowerPort' + PaginatedPowerPortTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PowerPortTemplate' + PaginatedPrefixList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Prefix' + PaginatedProviderAccountList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ProviderAccount' + PaginatedProviderList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Provider' + PaginatedProviderNetworkList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ProviderNetwork' + PaginatedRIRList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RIR' + PaginatedRackGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RackGroup' + PaginatedRackList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Rack' + PaginatedRackReservationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RackReservation' + PaginatedRackRoleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RackRole' + PaginatedRackTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RackType' + PaginatedRackUnitList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RackUnit' + PaginatedRearPortList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RearPort' + PaginatedRearPortTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RearPortTemplate' + PaginatedRegionList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Region' + PaginatedRoleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Role' + PaginatedRouteTargetList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/RouteTarget' + PaginatedSavedFilterList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/SavedFilter' + PaginatedScriptList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Script' + PaginatedServiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Service' + PaginatedServiceTemplateList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ServiceTemplate' + PaginatedSiteGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/SiteGroup' + PaginatedSiteList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Site' + PaginatedSubscriptionList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Subscription' + PaginatedTableConfigList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/TableConfig' + PaginatedTagList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Tag' + PaginatedTaggedItemList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/TaggedItem' + PaginatedTenantGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/TenantGroup' + PaginatedTenantList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Tenant' + PaginatedTokenList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Token' + PaginatedTunnelGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/TunnelGroup' + PaginatedTunnelList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Tunnel' + PaginatedTunnelTerminationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/TunnelTermination' + PaginatedUserList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/User' + PaginatedVLANGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VLANGroup' + PaginatedVLANList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VLAN' + PaginatedVLANTranslationPolicyList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VLANTranslationPolicy' + PaginatedVLANTranslationRuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRule' + PaginatedVMInterfaceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VMInterface' + PaginatedVRFList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VRF' + PaginatedVirtualChassisList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualChassis' + PaginatedVirtualCircuitList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualCircuit' + PaginatedVirtualCircuitTerminationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitTermination' + PaginatedVirtualCircuitTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualCircuitType' + PaginatedVirtualDeviceContextList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualDeviceContext' + PaginatedVirtualDiskList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualDisk' + PaginatedVirtualMachineTypeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualMachineType' + PaginatedVirtualMachineWithConfigContextList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/VirtualMachineWithConfigContext' + PaginatedWebhookList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Webhook' + PaginatedWirelessLANGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/WirelessLANGroup' + PaginatedWirelessLANList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/WirelessLAN' + PaginatedWirelessLinkList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&limit=100 + results: + type: array + items: + $ref: '#/components/schemas/WirelessLink' + PatchedASNRangeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + rir: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRIRRequest' + start: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + end: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedASNRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + asn: + type: integer + maximum: 4294967295 + minimum: 1 + format: int64 + description: 16- or 32-bit autonomous system number + rir: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRIRRequest' + nullable: true + nullable: true + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + sites: + type: array + items: + type: integer + PatchedBookmarkRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + PatchedCableBundleRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedCircuitGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedCircuitTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + circuit: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitRequest' + term_side: + enum: + - A + - Z + type: string + description: |- + * `A` - A + * `Z` - Z + x-spec-enum-id: 95b8fcc737f355d0 + title: Termination side + termination_type: + type: string + nullable: true + termination_id: + type: integer + nullable: true + port_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Port speed (Kbps) + description: Physical circuit speed + upstream_speed: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Upstream speed (Kbps) + description: Upstream speed, if different from port speed + xconnect_id: + type: string + title: Cross-connect ID + description: ID of the local cross-connect + maxLength: 50 + pp_info: + type: string + title: Patch panel/port(s) + description: Patch panel ID and port number(s) + maxLength: 100 + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedCircuitTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedClusterGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedClusterTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedConfigContextProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + schema: + nullable: true + description: A JSON schema specifying the structure of the context data + for this profile + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + PatchedConfigContextRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + weight: + type: integer + maximum: 32767 + minimum: 0 + profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigContextProfileRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + is_active: + type: boolean + regions: + type: array + items: + type: integer + site_groups: + type: array + items: + type: integer + sites: + type: array + items: + type: integer + locations: + type: array + items: + type: integer + device_types: + type: array + items: + type: integer + roles: + type: array + items: + type: integer + platforms: + type: array + items: + type: integer + cluster_types: + type: array + items: + type: integer + cluster_groups: + type: array + items: + type: integer + clusters: + type: array + items: + type: integer + tenant_groups: + type: array + items: + type: integer + tenants: + type: array + items: + type: integer + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + type: string + minLength: 1 + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + data: {} + PatchedConfigTemplateRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + environment_params: + nullable: true + title: Environment parameters + description: Any additional + parameters to pass when constructing the Jinja environment + template_code: + type: string + minLength: 1 + description: Jinja template code. + mime_type: + type: string + description: Defaults to text/plain; charset=utf-8 + maxLength: 50 + file_name: + type: string + description: Filename to give to the rendered export file + maxLength: 200 + file_extension: + type: string + description: Extension to append to the rendered filename + maxLength: 15 + as_attachment: + type: boolean + description: Download file as attachment + debug: + type: boolean + description: Enable verbose error output when rendering this template. Not + recommended for production use. + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + auto_sync_enabled: + type: boolean + description: Enable automatic synchronization of data when the data file + is updated + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + PatchedContactRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + groups: + type: array + items: + type: integer + name: + type: string + minLength: 1 + maxLength: 100 + title: + type: string + maxLength: 100 + phone: + type: string + maxLength: 50 + email: + type: string + format: email + maxLength: 254 + address: + type: string + maxLength: 200 + link: + type: string + format: uri + maxLength: 200 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedContactRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedCustomLinkRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 100 + enabled: + type: boolean + link_text: + type: string + minLength: 1 + description: Jinja2 template code for link text + link_url: + type: string + minLength: 1 + description: Jinja2 template code for link URL + weight: + type: integer + maximum: 32767 + minimum: 0 + group_name: + type: string + description: Links with the same group will appear as a dropdown menu + maxLength: 50 + button_class: + enum: + - default + - blue + - indigo + - purple + - pink + - red + - orange + - yellow + - green + - teal + - cyan + - gray + - black + - white + - ghost-dark + type: string + x-spec-enum-id: 5e54b3bd086685ce + description: |- + The class of the first link in a group will be used for the dropdown button + + * `default` - Default + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + * `ghost-dark` - Link + new_window: + type: boolean + description: Force link to open in a new window + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + PatchedDashboardRequest: + type: object + properties: + layout: {} + config: {} + PatchedDeviceBayRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + enabled: + type: boolean + description: + type: string + maxLength: 200 + installed_device: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedDeviceBayTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + enabled: + type: boolean + description: + type: string + maxLength: 200 + PatchedExportTemplateRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + environment_params: + nullable: true + title: Environment parameters + description: Any additional + parameters to pass when constructing the Jinja environment + template_code: + type: string + minLength: 1 + description: Jinja template code. + mime_type: + type: string + description: Defaults to text/plain; charset=utf-8 + maxLength: 50 + file_name: + type: string + description: Filename to give to the rendered export file + maxLength: 200 + file_extension: + type: string + description: Extension to append to the rendered filename + maxLength: 15 + as_attachment: + type: boolean + description: Download file as attachment + data_source: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDataSourceRequest' + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + PatchedFHRPGroupAssignmentRequest: + type: object + description: Adds support for custom fields and tags. + properties: + group: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefFHRPGroupRequest' + interface_type: + type: string + interface_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + priority: + type: integer + maximum: 255 + minimum: 0 + PatchedFHRPGroupRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + maxLength: 100 + protocol: + enum: + - vrrp2 + - vrrp3 + - carp + - clusterxl + - hsrp + - glbp + - other + type: string + description: |- + * `vrrp2` - VRRPv2 + * `vrrp3` - VRRPv3 + * `carp` - CARP + * `clusterxl` - ClusterXL + * `hsrp` - HSRP + * `glbp` - GLBP + * `other` - Other + x-spec-enum-id: 98de93c9f65d1c65 + group_id: + type: integer + maximum: 32767 + minimum: 0 + auth_type: + enum: + - plaintext + - md5 + - '' + - null + type: string + description: |- + * `plaintext` - Plaintext + * `md5` - MD5 + x-spec-enum-id: 565396e386e1542a + nullable: true + title: Authentication type + auth_key: + type: string + title: Authentication key + maxLength: 255 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedGroupRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 150 + description: + type: string + maxLength: 200 + permissions: + type: array + items: + type: integer + PatchedImageAttachmentRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + name: + type: string + maxLength: 50 + image: + type: string + format: binary + description: + type: string + maxLength: 200 + PatchedInventoryItemRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedInventoryItemTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + parent: + type: integer + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + part_id: + type: string + description: Manufacturer-assigned part identifier + maxLength: 50 + description: + type: string + maxLength: 200 + component_type: + type: string + nullable: true + component_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + PatchedL2VPNTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + l2vpn: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefL2VPNRequest' + assigned_object_type: + type: string + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedMACAddressRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + mac_address: + type: string + minLength: 1 + assigned_object_type: + type: string + nullable: true + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedManufacturerRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedModuleBayRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + position: + type: string + description: Identifier to reference when renaming installed components + maxLength: 30 + enabled: + type: boolean + description: + type: string + maxLength: 200 + installed_module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedModuleBayTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + position: + type: string + description: Identifier to reference when renaming installed components + maxLength: 30 + enabled: + type: boolean + description: + type: string + maxLength: 200 + PatchedModuleTypeProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + schema: + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedNotificationGroupRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + groups: + type: array + items: + type: integer + users: + type: array + items: + type: integer + PatchedNotificationRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + read: + type: string + format: date-time + nullable: true + event_type: + enum: + - object_created + - object_updated + - object_deleted + - job_started + - job_completed + - job_failed + - job_errored + type: string + description: |- + * `object_created` - Object created + * `object_updated` - Object updated + * `object_deleted` - Object deleted + * `job_started` - Job started + * `job_completed` - Job completed + * `job_failed` - Job failed + * `job_errored` - Job errored + x-spec-enum-id: 01e557313a5c7bd2 + title: Event + PatchedObjectPermissionRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + enabled: + type: boolean + object_types: + type: array + items: + type: string + actions: + type: array + items: + type: string + minLength: 1 + maxLength: 30 + description: The list of actions granted by this permission + constraints: + nullable: true + description: Queryset filter matching the applicable objects of the selected + type(s) + groups: + type: array + items: + type: integer + users: + type: array + items: + type: integer + PatchedOwnerGroupRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + PatchedOwnerRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + name: + type: string + minLength: 1 + maxLength: 100 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerGroupRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + user_groups: + type: array + items: + type: integer + users: + type: array + items: + type: integer + PatchedPowerPanelRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedProviderAccountRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + name: + type: string + default: '' + maxLength: 100 + account: + type: string + minLength: 1 + title: Account ID + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedProviderNetworkRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + name: + type: string + minLength: 1 + maxLength: 100 + service_id: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedProviderRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Full name of the provider + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + accounts: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + asns: + type: array + items: + type: integer + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedRIRRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + is_private: + type: boolean + title: Private + description: IP space managed by this RIR is considered private + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedRackGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedRackRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + weight: + type: integer + maximum: 32767 + minimum: 0 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedRouteTargetRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Route target value (formatted in accordance with RFC 4360) + maxLength: 21 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedSavedFilterRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + user: + type: integer + nullable: true + weight: + type: integer + maximum: 32767 + minimum: 0 + enabled: + type: boolean + shared: + type: boolean + parameters: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + PatchedScriptInputRequest: + type: object + properties: + data: {} + commit: + type: boolean + schedule_at: + type: string + format: date-time + nullable: true + interval: + type: integer + nullable: true + notifications: + enum: + - always + - on_failure + - never + type: string + description: |- + * `always` - Always + * `on_failure` - On failure + * `never` - Never + x-spec-enum-id: 57071f4400340a5c + default: always + PatchedSubscriptionRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + PatchedTableConfigRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + table: + type: string + minLength: 1 + maxLength: 100 + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + user: + type: integer + nullable: true + weight: + type: integer + maximum: 32767 + minimum: 0 + enabled: + type: boolean + shared: + type: boolean + columns: + type: array + items: + type: string + minLength: 1 + maxLength: 100 + ordering: + type: array + items: + type: string + minLength: 1 + maxLength: 100 + nullable: true + PatchedTagRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + pattern: ^[-\w]+$ + maxLength: 100 + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + weight: + type: integer + maximum: 32767 + minimum: 0 + object_types: + type: array + items: + type: string + PatchedTenantRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantGroupRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedTokenRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - v1 + * `2` - v2 + x-spec-enum-id: b5df70f0bffd12cb + minimum: 0 + maximum: 32767 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + description: + type: string + maxLength: 200 + expires: + type: string + format: date-time + nullable: true + last_used: + type: string + format: date-time + nullable: true + enabled: + type: boolean + description: Disable to temporarily revoke this token without deleting it. + write_enabled: + type: boolean + description: Permit create/update/delete operations using this token + pepper_id: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: ID of the cryptographic pepper used to hash the token (v2 only) + token: + type: string + minLength: 1 + PatchedTunnelGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedUserRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + username: + type: string + minLength: 1 + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + pattern: ^[\w.@+-]+$ + maxLength: 150 + password: + type: string + writeOnly: true + minLength: 1 + maxLength: 128 + first_name: + type: string + maxLength: 150 + last_name: + type: string + maxLength: 150 + email: + type: string + format: email + title: Email address + maxLength: 254 + is_active: + type: boolean + title: Active + description: Designates whether this user should be treated as active. Unselect + this instead of deleting accounts. + date_joined: + type: string + format: date-time + last_login: + type: string + format: date-time + nullable: true + groups: + type: array + items: + type: integer + permissions: + type: array + items: + type: integer + PatchedVLANGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + vid_ranges: + type: array + items: + $ref: '#/components/schemas/IntegerRangeRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedVLANTranslationPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedVLANTranslationRuleRequest: + type: object + description: Adds support for custom fields and tags. + properties: + policy: + type: integer + local_vid: + type: integer + maximum: 4094 + minimum: 1 + title: Local VLAN ID + description: Numeric VLAN ID (1-4094) + remote_vid: + type: integer + maximum: 4094 + minimum: 1 + title: Remote VLAN ID + description: Numeric VLAN ID (1-4094) + description: + type: string + maxLength: 200 + PatchedVRFRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + rd: + type: string + nullable: true + title: Route distinguisher + description: Unique route distinguisher (as defined in RFC 4364) + maxLength: 21 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + enforce_unique: + type: boolean + title: Enforce unique space + description: Prevent duplicate prefixes/IP addresses within this VRF + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + import_targets: + type: array + items: + type: integer + export_targets: + type: array + items: + type: integer + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedVirtualCircuitTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedVirtualDiskRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + virtual_machine: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualMachineRequest' + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + maxLength: 200 + size: + type: integer + maximum: 2147483647 + minimum: 0 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedVirtualMachineTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + default_platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + default_vcpus: + type: number + format: double + maximum: 10000 + minimum: 0.01 + exclusiveMaximum: true + nullable: true + default_memory: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Default memory (MB) + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWebhookRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 150 + description: + type: string + maxLength: 200 + payload_url: + type: string + minLength: 1 + title: URL + description: This URL will be called using the HTTP method defined when + the webhook is called. Jinja2 template processing is supported with the + same context as the request body. + maxLength: 500 + http_method: + enum: + - GET + - POST + - PUT + - PATCH + - DELETE + type: string + description: |- + * `GET` - GET + * `POST` - POST + * `PUT` - PUT + * `PATCH` - PATCH + * `DELETE` - DELETE + x-spec-enum-id: 867bf764d3b1eeaa + http_content_type: + type: string + minLength: 1 + description: The complete list of official content types is available here. + maxLength: 100 + additional_headers: + type: string + description: 'User-supplied HTTP headers to be sent with the request in + addition to the HTTP content type. Headers should be defined in the format + Name: Value. Jinja2 template processing is supported with + the same context as the request body (below).' + body_template: + type: string + description: 'Jinja2 template for a custom request body. If blank, a JSON + object representing the change will be included. Available context data + includes: event, model, timestamp, + username, request_id, and data.' + secret: + type: string + description: When provided, the request will include a X-Hook-Signature + header containing a HMAC hex digest of the payload body using the secret + as the key. The secret is not transmitted in the request. + maxLength: 255 + ssl_verification: + type: boolean + description: Enable SSL certificate verification. Disable with caution! + ca_file_path: + type: string + nullable: true + description: The specific CA certificate file to use for SSL verification. + Leave blank to use the system defaults. + maxLength: 4096 + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + PatchedWritableAggregateRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + prefix: + type: string + minLength: 1 + rir: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRIRRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + date_added: + type: string + format: date + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableCableRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + type: + enum: + - cat3 + - cat5 + - cat5e + - cat6 + - cat6a + - cat7 + - cat7a + - cat8 + - mrj21-trunk + - dac-active + - dac-passive + - coaxial + - rg-6 + - rg-8 + - rg-11 + - rg-59 + - rg-62 + - rg-213 + - lmr-100 + - lmr-200 + - lmr-400 + - mmf + - mmf-om1 + - mmf-om2 + - mmf-om3 + - mmf-om4 + - mmf-om5 + - smf + - smf-os1 + - smf-os2 + - aoc + - power + - usb + - '' + - null + type: string + description: |- + * `cat3` - CAT3 + * `cat5` - CAT5 + * `cat5e` - CAT5e + * `cat6` - CAT6 + * `cat6a` - CAT6a + * `cat7` - CAT7 + * `cat7a` - CAT7a + * `cat8` - CAT8 + * `mrj21-trunk` - MRJ21 Trunk + * `dac-active` - Direct Attach Copper (Active) + * `dac-passive` - Direct Attach Copper (Passive) + * `coaxial` - Coaxial + * `rg-6` - RG-6 + * `rg-8` - RG-8 + * `rg-11` - RG-11 + * `rg-59` - RG-59 + * `rg-62` - RG-62 + * `rg-213` - RG-213 + * `lmr-100` - LMR-100 + * `lmr-200` - LMR-200 + * `lmr-400` - LMR-400 + * `mmf` - Multimode Fiber + * `mmf-om1` - Multimode Fiber (OM1) + * `mmf-om2` - Multimode Fiber (OM2) + * `mmf-om3` - Multimode Fiber (OM3) + * `mmf-om4` - Multimode Fiber (OM4) + * `mmf-om5` - Multimode Fiber (OM5) + * `smf` - Single-mode Fiber + * `smf-os1` - Single-mode Fiber (OS1) + * `smf-os2` - Single-mode Fiber (OS2) + * `aoc` - Active Optical Cabling (AOC) + * `power` - Power + * `usb` - USB + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + a_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObjectRequest' + b_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObjectRequest' + status: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + profile: + enum: + - single-1c1p + - single-1c2p + - single-1c4p + - single-1c6p + - single-1c8p + - single-1c12p + - single-1c16p + - trunk-2c1p + - trunk-2c2p + - trunk-2c4p + - trunk-2c4p-shuffle + - trunk-2c6p + - trunk-2c8p + - trunk-2c12p + - trunk-4c1p + - trunk-4c2p + - trunk-4c4p + - trunk-4c4p-shuffle + - trunk-4c6p + - trunk-4c8p + - trunk-8c4p + - breakout-1c2p-2c1p + - breakout-1c4p-4c1p + - breakout-1c6p-6c1p + - breakout-2c4p-8c1p-shuffle + - '' + type: string + description: |- + * `single-1c1p` - 1C1P + * `single-1c2p` - 1C2P + * `single-1c4p` - 1C4P + * `single-1c6p` - 1C6P + * `single-1c8p` - 1C8P + * `single-1c12p` - 1C12P + * `single-1c16p` - 1C16P + * `trunk-2c1p` - 2C1P trunk + * `trunk-2c2p` - 2C2P trunk + * `trunk-2c4p` - 2C4P trunk + * `trunk-2c4p-shuffle` - 2C4P trunk (shuffle) + * `trunk-2c6p` - 2C6P trunk + * `trunk-2c8p` - 2C8P trunk + * `trunk-2c12p` - 2C12P trunk + * `trunk-4c1p` - 4C1P trunk + * `trunk-4c2p` - 4C2P trunk + * `trunk-4c4p` - 4C4P trunk + * `trunk-4c4p-shuffle` - 4C4P trunk (shuffle) + * `trunk-4c6p` - 4C6P trunk + * `trunk-4c8p` - 4C8P trunk + * `trunk-8c4p` - 8C4P trunk + * `breakout-1c2p-2c1p` - 1C2P:2C1P breakout + * `breakout-1c4p-4c1p` - 1C4P:4C1P breakout + * `breakout-1c6p-6c1p` - 1C6P:6C1P breakout + * `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle) + x-spec-enum-id: f566e6df6572f5d0 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + bundle: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefCableBundleRequest' + nullable: true + nullable: true + label: + type: string + maxLength: 100 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + length: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + length_unit: + enum: + - km + - m + - cm + - mi + - ft + - in + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `cm` - Centimeters + * `mi` - Miles + * `ft` - Feet + * `in` - Inches + x-spec-enum-id: 6e7645525ba02462 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableCircuitGroupAssignmentRequest: + type: object + description: Base serializer for group assignments under CircuitSerializer. + properties: + group: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitGroupRequest' + member_type: + type: string + member_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + priority: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + - null + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + PatchedWritableCircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + provider_account: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefProviderAccountRequest' + nullable: true + nullable: true + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitTypeRequest' + status: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + install_date: + type: string + format: date + nullable: true + title: Installed + termination_date: + type: string + format: date + nullable: true + title: Terminates + commit_rate: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Commit rate (Kbps) + description: Committed rate + description: + type: string + maxLength: 200 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + assignments: + type: array + items: + $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request' + PatchedWritableClusterRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefClusterTypeRequest' + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterGroupRequest' + nullable: true + nullable: true + status: + enum: + - planned + - staging + - active + - decommissioning + - offline + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `offline` - Offline + x-spec-enum-id: 65a25166053759eb + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableConsolePortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: |- + Physical port type + + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + speed: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + minimum: 0 + maximum: 2147483647 + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableConsolePortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: + type: string + maxLength: 200 + PatchedWritableConsoleServerPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: |- + Physical port type + + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + speed: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + minimum: 0 + maximum: 2147483647 + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableConsoleServerPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: + type: string + maxLength: 200 + PatchedWritableContactAssignmentRequest: + type: object + description: Adds support for custom fields and tags. + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + contact: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefContactRequest' + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefContactRoleRequest' + nullable: true + nullable: true + priority: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + - null + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableContactGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableCustomFieldChoiceSetRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + base_choices: + enum: + - IATA + - ISO_3166 + - UN_LOCODE + - '' + - null + type: string + x-spec-enum-id: cf0efb5195f85007 + nullable: true + description: |- + Base set of predefined choices (optional) + + * `IATA` - IATA (Airport codes) + * `ISO_3166` - ISO 3166 (Country codes) + * `UN_LOCODE` - UN/LOCODE (Location codes) + extra_choices: + type: array + items: + type: array + items: {} + maxItems: 2 + minItems: 2 + choice_colors: + type: object + additionalProperties: + enum: + - blue + - indigo + - purple + - pink + - red + - orange + - yellow + - green + - teal + - cyan + - gray + - black + - white + type: string + description: |- + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + x-spec-enum-id: de0a6a124020dfe0 + order_alphabetically: + type: boolean + description: Choices are automatically ordered alphabetically + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + PatchedWritableCustomFieldRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + type: + enum: + - text + - longtext + - integer + - decimal + - boolean + - date + - datetime + - url + - json + - select + - multiselect + - object + - multiobject + type: string + x-spec-enum-id: 47c52a3d983e924c + description: |- + The type of data this custom field holds + + * `text` - Text + * `longtext` - Text (long) + * `integer` - Integer + * `decimal` - Decimal + * `boolean` - Boolean (true/false) + * `date` - Date + * `datetime` - Date & time + * `url` - URL + * `json` - JSON + * `select` - Selection + * `multiselect` - Multiple selection + * `object` - Object + * `multiobject` - Multiple objects + related_object_type: + type: string + nullable: true + name: + type: string + minLength: 1 + description: Internal field name + pattern: ^[a-z0-9_]+$ + maxLength: 50 + label: + type: string + description: Name of the field as displayed to users (if not provided, 'the + field's name will be used) + maxLength: 50 + group_name: + type: string + description: Custom fields within the same group will be displayed together + maxLength: 50 + description: + type: string + maxLength: 200 + required: + type: boolean + description: This field is required when creating new objects or editing + an existing object. + unique: + type: boolean + title: Must be unique + description: The value of this field must be unique for the assigned object + search_weight: + type: integer + maximum: 32767 + minimum: 0 + description: Weighting for search. Lower values are considered more important. + Fields with a search weight of zero will be ignored. + filter_logic: + enum: + - disabled + - loose + - exact + type: string + x-spec-enum-id: d168820c798ae45a + description: |- + Loose matches any instance of a given string; exact matches the entire field. + + * `disabled` - Disabled + * `loose` - Loose + * `exact` - Exact + ui_visible: + enum: + - always + - if-set + - hidden + type: string + x-spec-enum-id: f32800c399b927b6 + description: |- + Specifies whether the custom field is displayed in the UI + + * `always` - Always + * `if-set` - If set + * `hidden` - Hidden + ui_editable: + enum: + - 'yes' + - 'no' + - hidden + type: string + x-spec-enum-id: 336f52760e62022f + description: |- + Specifies whether the custom field value can be edited in the UI + + * `yes` - Yes + * `no` - No + * `hidden` - Hidden + is_cloneable: + type: boolean + description: Replicate this value when cloning objects + default: + nullable: true + description: Default value for the field (must be a JSON value). Encapsulate + strings with double quotes (e.g. "Foo"). + related_object_filter: + nullable: true + description: Filter the object selection choices using a query_params dict + (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo"). + weight: + type: integer + maximum: 32767 + minimum: 0 + title: Display weight + description: Fields with higher weights appear lower in a form. + validation_minimum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Minimum value + description: Minimum allowed value (for numeric fields) + validation_maximum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Maximum value + description: Maximum allowed value (for numeric fields) + validation_regex: + type: string + description: Regular expression to enforce on text field values. Use ^ and + $ to force matching of entire string. For example, ^[A-Z]{3}$ + will limit values to exactly three uppercase letters. + maxLength: 500 + validation_schema: + nullable: true + description: A JSON schema definition for validating the custom field value + choice_set: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefCustomFieldChoiceSetRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableDataSourceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + type: + type: string + minLength: 1 + maxLength: 50 + source_url: + type: string + minLength: 1 + title: URL + maxLength: 200 + enabled: + type: boolean + description: + type: string + maxLength: 200 + sync_interval: + enum: + - 1 + - 60 + - 720 + - 1440 + - 10080 + - 43200 + - null + type: integer + description: |- + * `1` - Minutely + * `60` - Hourly + * `720` - 12 hours + * `1440` - Daily + * `10080` - Weekly + * `43200` - 30 days + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + minimum: 0 + maximum: 32767 + parameters: + nullable: true + ignore_rules: + type: string + description: Patterns (one per line) matching files or paths to ignore when + syncing + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + custom_fields: + type: object + additionalProperties: {} + PatchedWritableDeviceRoleRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + vm_role: + type: boolean + description: Virtual machines may be assigned to this role + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableDeviceTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + default_platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + u_height: + type: number + format: double + maximum: 1000 + minimum: 0 + exclusiveMaximum: true + default: 1.0 + title: Position (U) + exclude_from_utilization: + type: boolean + description: Devices of this type are excluded when calculating rack utilization. + is_full_depth: + type: boolean + description: Device consumes both front and rear rack faces. + subdevice_role: + enum: + - parent + - child + - '' + - null + type: string + x-spec-enum-id: 65a61d5e1deb4a24 + nullable: true + title: Parent/child status + description: |- + Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. + + * `parent` - Parent + * `child` - Child + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + front_image: + type: string + format: binary + nullable: true + rear_image: + type: string + format: binary + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableDeviceWithConfigContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + nullable: true + maxLength: 64 + device_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + role: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRoleRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + serial: + type: string + title: Serial number + description: Chassis serial number, assigned by the manufacturer + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + rack: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRequest' + nullable: true + nullable: true + position: + type: number + format: double + maximum: 1000 + minimum: 0.5 + exclusiveMaximum: true + nullable: true + title: Position (U) + face: + enum: + - front + - rear + - '' + - null + type: string + description: |- + * `front` - Front + * `rear` - Rear + x-spec-enum-id: d2fb9b3f75158b83 + nullable: true + title: Rack face + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + status: + enum: + - offline + - active + - planned + - staged + - failed + - inventory + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `inventory` - Inventory + * `decommissioning` - Decommissioning + x-spec-enum-id: 65feb4244cc9110c + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + oob_ip: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + cluster: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterRequest' + nullable: true + nullable: true + virtual_chassis: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVirtualChassisRequest' + nullable: true + nullable: true + vc_position: + type: integer + maximum: 255 + minimum: 0 + nullable: true + vc_priority: + type: integer + maximum: 255 + minimum: 0 + nullable: true + description: Virtual chassis master election priority + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableEventRuleRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 150 + enabled: + type: boolean + event_types: + type: array + items: + enum: + - object_created + - object_updated + - object_deleted + - job_started + - job_completed + - job_failed + - job_errored + type: string + description: |- + * `object_created` - Object created + * `object_updated` - Object updated + * `object_deleted` - Object deleted + * `job_started` - Job started + * `job_completed` - Job completed + * `job_failed` - Job failed + * `job_errored` - Job errored + x-spec-enum-id: 01e557313a5c7bd2 + description: The types of event which will trigger this rule. + conditions: + nullable: true + description: A set of conditions which determine whether the event will + be generated. + action_type: + enum: + - webhook + - script + - notification + type: string + description: |- + * `webhook` - Webhook + * `script` - Script + * `notification` - Notification + x-spec-enum-id: 287901b937995956 + action_object_type: + type: string + action_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + PatchedWritableFrontPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortMappingRequest' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableFrontPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateMappingRequest' + description: + type: string + maxLength: 200 + PatchedWritableIKEPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - IKEv1 + * `2` - IKEv2 + x-spec-enum-id: 00872b77916a1fde + minimum: 0 + maximum: 32767 + mode: + enum: + - aggressive + - main + - '' + - null + type: string + description: |- + * `aggressive` - Aggressive + * `main` - Main + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + proposals: + type: array + items: + type: integer + preshared_key: + type: string + title: Pre-shared key + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableIKEProposalRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + authentication_method: + enum: + - preshared-keys + - certificates + - rsa-signatures + - dsa-signatures + type: string + description: |- + * `preshared-keys` - Pre-shared keys + * `certificates` - Certificates + * `rsa-signatures` - RSA signatures + * `dsa-signatures` - DSA signatures + x-spec-enum-id: a21158c52d0c455a + encryption_algorithm: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + authentication_algorithm: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + - '' + - null + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + group: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + type: integer + x-spec-enum-id: dbef43be795462a8 + description: |- + Diffie-Hellman group ID + + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + minimum: 0 + maximum: 32767 + sa_lifetime: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Security association lifetime (in seconds) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableIPAddressRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + address: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + - dhcp + - slaac + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: |- + The operational status of this IP + + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + * `dhcp` - DHCP + * `slaac` - SLAAC + role: + enum: + - loopback + - secondary + - anycast + - vip + - vrrp + - hsrp + - glbp + - carp + - '' + - null + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: |- + The functional role of this IP + + * `loopback` - Loopback + * `secondary` - Secondary + * `anycast` - Anycast + * `vip` - VIP + * `vrrp` - VRRP + * `hsrp` - HSRP + * `glbp` - GLBP + * `carp` - CARP + assigned_object_type: + type: string + nullable: true + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + nat_inside: + type: integer + nullable: true + title: NAT (inside) + description: The IP for which this address is the "outside" IP + dns_name: + type: string + description: Hostname or FQDN (not case-sensitive) + pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ + maxLength: 255 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableIPRangeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + start_address: + type: string + minLength: 1 + end_address: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + type: string + x-spec-enum-id: ca933c38b935e547 + description: |- + Operational status of this range + + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + mark_populated: + type: boolean + description: Prevent the creation of IP addresses within this range + mark_utilized: + type: boolean + description: Report space as fully utilized + PatchedWritableIPSecPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + proposals: + type: array + items: + type: integer + pfs_group: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + - null + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: |- + Diffie-Hellman group for Perfect Forward Secrecy + + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + minimum: 0 + maximum: 32767 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableIPSecProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + mode: + enum: + - esp + - ah + type: string + description: |- + * `esp` - ESP + * `ah` - AH + x-spec-enum-id: 87ac6ada0da14ccf + ike_policy: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefIKEPolicyRequest' + ipsec_policy: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefIPSecPolicyRequest' + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableIPSecProposalRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + encryption_algorithm: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + - '' + - null + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + authentication_algorithm: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + - '' + - null + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + sa_lifetime_seconds: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (seconds) + description: Security association lifetime (seconds) + sa_lifetime_data: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (KB) + description: Security association lifetime (in kilobytes) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableInterfaceRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + vdcs: + type: array + items: + type: integer + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + enabled: + type: boolean + parent: + type: integer + nullable: true + title: Parent interface + bridge: + type: integer + nullable: true + title: Bridge interface + lag: + type: integer + nullable: true + title: Parent LAG + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + primary_mac_address: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefMACAddressRequest' + nullable: true + nullable: true + speed: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + title: Speed (Kbps) + duplex: + enum: + - half + - full + - auto + - '' + - null + type: string + description: |- + * `half` - Half + * `full` - Full + * `auto` - Auto + x-spec-enum-id: 368458a2b67c916b + nullable: true + wwn: + type: string + nullable: true + mgmt_only: + type: boolean + title: Management only + description: This interface is used only for out-of-band management + description: + type: string + maxLength: 200 + mode: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + - null + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: |- + IEEE 802.1Q tagging strategy + + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + rf_role: + enum: + - ap + - station + - '' + - null + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + rf_channel: + enum: + - 2.4g-1-2412-22 + - 2.4g-2-2417-22 + - 2.4g-3-2422-22 + - 2.4g-4-2427-22 + - 2.4g-5-2432-22 + - 2.4g-6-2437-22 + - 2.4g-7-2442-22 + - 2.4g-8-2447-22 + - 2.4g-9-2452-22 + - 2.4g-10-2457-22 + - 2.4g-11-2462-22 + - 2.4g-12-2467-22 + - 2.4g-13-2472-22 + - 5g-32-5160-20 + - 5g-34-5170-40 + - 5g-36-5180-20 + - 5g-38-5190-40 + - 5g-40-5200-20 + - 5g-42-5210-80 + - 5g-44-5220-20 + - 5g-46-5230-40 + - 5g-48-5240-20 + - 5g-50-5250-160 + - 5g-52-5260-20 + - 5g-54-5270-40 + - 5g-56-5280-20 + - 5g-58-5290-80 + - 5g-60-5300-20 + - 5g-62-5310-40 + - 5g-64-5320-20 + - 5g-100-5500-20 + - 5g-102-5510-40 + - 5g-104-5520-20 + - 5g-106-5530-80 + - 5g-108-5540-20 + - 5g-110-5550-40 + - 5g-112-5560-20 + - 5g-114-5570-160 + - 5g-116-5580-20 + - 5g-118-5590-40 + - 5g-120-5600-20 + - 5g-122-5610-80 + - 5g-124-5620-20 + - 5g-126-5630-40 + - 5g-128-5640-20 + - 5g-132-5660-20 + - 5g-134-5670-40 + - 5g-136-5680-20 + - 5g-138-5690-80 + - 5g-140-5700-20 + - 5g-142-5710-40 + - 5g-144-5720-20 + - 5g-149-5745-20 + - 5g-151-5755-40 + - 5g-153-5765-20 + - 5g-155-5775-80 + - 5g-157-5785-20 + - 5g-159-5795-40 + - 5g-161-5805-20 + - 5g-163-5815-160 + - 5g-165-5825-20 + - 5g-167-5835-40 + - 5g-169-5845-20 + - 5g-171-5855-80 + - 5g-173-5865-20 + - 5g-175-5875-40 + - 5g-177-5885-20 + - 6g-1-5955-20 + - 6g-3-5965-40 + - 6g-5-5975-20 + - 6g-7-5985-80 + - 6g-9-5995-20 + - 6g-11-6005-40 + - 6g-13-6015-20 + - 6g-15-6025-160 + - 6g-17-6035-20 + - 6g-19-6045-40 + - 6g-21-6055-20 + - 6g-23-6065-80 + - 6g-25-6075-20 + - 6g-27-6085-40 + - 6g-29-6095-20 + - 6g-31-6105-320 + - 6g-33-6115-20 + - 6g-35-6125-40 + - 6g-37-6135-20 + - 6g-39-6145-80 + - 6g-41-6155-20 + - 6g-43-6165-40 + - 6g-45-6175-20 + - 6g-47-6185-160 + - 6g-49-6195-20 + - 6g-51-6205-40 + - 6g-53-6215-20 + - 6g-55-6225-80 + - 6g-57-6235-20 + - 6g-59-6245-40 + - 6g-61-6255-20 + - 6g-65-6275-20 + - 6g-67-6285-40 + - 6g-69-6295-20 + - 6g-71-6305-80 + - 6g-73-6315-20 + - 6g-75-6325-40 + - 6g-77-6335-20 + - 6g-79-6345-160 + - 6g-81-6355-20 + - 6g-83-6365-40 + - 6g-85-6375-20 + - 6g-87-6385-80 + - 6g-89-6395-20 + - 6g-91-6405-40 + - 6g-93-6415-20 + - 6g-95-6425-320 + - 6g-97-6435-20 + - 6g-99-6445-40 + - 6g-101-6455-20 + - 6g-103-6465-80 + - 6g-105-6475-20 + - 6g-107-6485-40 + - 6g-109-6495-20 + - 6g-111-6505-160 + - 6g-113-6515-20 + - 6g-115-6525-40 + - 6g-117-6535-20 + - 6g-119-6545-80 + - 6g-121-6555-20 + - 6g-123-6565-40 + - 6g-125-6575-20 + - 6g-129-6595-20 + - 6g-131-6605-40 + - 6g-133-6615-20 + - 6g-135-6625-80 + - 6g-137-6635-20 + - 6g-139-6645-40 + - 6g-141-6655-20 + - 6g-143-6665-160 + - 6g-145-6675-20 + - 6g-147-6685-40 + - 6g-149-6695-20 + - 6g-151-6705-80 + - 6g-153-6715-20 + - 6g-155-6725-40 + - 6g-157-6735-20 + - 6g-159-6745-320 + - 6g-161-6755-20 + - 6g-163-6765-40 + - 6g-165-6775-20 + - 6g-167-6785-80 + - 6g-169-6795-20 + - 6g-171-6805-40 + - 6g-173-6815-20 + - 6g-175-6825-160 + - 6g-177-6835-20 + - 6g-179-6845-40 + - 6g-181-6855-20 + - 6g-183-6865-80 + - 6g-185-6875-20 + - 6g-187-6885-40 + - 6g-189-6895-20 + - 6g-193-6915-20 + - 6g-195-6925-40 + - 6g-197-6935-20 + - 6g-199-6945-80 + - 6g-201-6955-20 + - 6g-203-6965-40 + - 6g-205-6975-20 + - 6g-207-6985-160 + - 6g-209-6995-20 + - 6g-211-7005-40 + - 6g-213-7015-20 + - 6g-215-7025-80 + - 6g-217-7035-20 + - 6g-219-7045-40 + - 6g-221-7055-20 + - 6g-225-7075-20 + - 6g-227-7085-40 + - 6g-229-7095-20 + - 6g-233-7115-20 + - 60g-1-58320-2160 + - 60g-2-60480-2160 + - 60g-3-62640-2160 + - 60g-4-64800-2160 + - 60g-5-66960-2160 + - 60g-6-69120-2160 + - 60g-9-59400-4320 + - 60g-10-61560-4320 + - 60g-11-63720-4320 + - 60g-12-65880-4320 + - 60g-13-68040-4320 + - 60g-17-60480-6480 + - 60g-18-62640-6480 + - 60g-19-64800-6480 + - 60g-20-66960-6480 + - 60g-25-61560-6480 + - 60g-26-63720-6480 + - 60g-27-65880-6480 + - '' + - null + type: string + description: |- + * `2.4g-1-2412-22` - 1 (2412 MHz) + * `2.4g-2-2417-22` - 2 (2417 MHz) + * `2.4g-3-2422-22` - 3 (2422 MHz) + * `2.4g-4-2427-22` - 4 (2427 MHz) + * `2.4g-5-2432-22` - 5 (2432 MHz) + * `2.4g-6-2437-22` - 6 (2437 MHz) + * `2.4g-7-2442-22` - 7 (2442 MHz) + * `2.4g-8-2447-22` - 8 (2447 MHz) + * `2.4g-9-2452-22` - 9 (2452 MHz) + * `2.4g-10-2457-22` - 10 (2457 MHz) + * `2.4g-11-2462-22` - 11 (2462 MHz) + * `2.4g-12-2467-22` - 12 (2467 MHz) + * `2.4g-13-2472-22` - 13 (2472 MHz) + * `5g-32-5160-20` - 32 (5160/20 MHz) + * `5g-34-5170-40` - 34 (5170/40 MHz) + * `5g-36-5180-20` - 36 (5180/20 MHz) + * `5g-38-5190-40` - 38 (5190/40 MHz) + * `5g-40-5200-20` - 40 (5200/20 MHz) + * `5g-42-5210-80` - 42 (5210/80 MHz) + * `5g-44-5220-20` - 44 (5220/20 MHz) + * `5g-46-5230-40` - 46 (5230/40 MHz) + * `5g-48-5240-20` - 48 (5240/20 MHz) + * `5g-50-5250-160` - 50 (5250/160 MHz) + * `5g-52-5260-20` - 52 (5260/20 MHz) + * `5g-54-5270-40` - 54 (5270/40 MHz) + * `5g-56-5280-20` - 56 (5280/20 MHz) + * `5g-58-5290-80` - 58 (5290/80 MHz) + * `5g-60-5300-20` - 60 (5300/20 MHz) + * `5g-62-5310-40` - 62 (5310/40 MHz) + * `5g-64-5320-20` - 64 (5320/20 MHz) + * `5g-100-5500-20` - 100 (5500/20 MHz) + * `5g-102-5510-40` - 102 (5510/40 MHz) + * `5g-104-5520-20` - 104 (5520/20 MHz) + * `5g-106-5530-80` - 106 (5530/80 MHz) + * `5g-108-5540-20` - 108 (5540/20 MHz) + * `5g-110-5550-40` - 110 (5550/40 MHz) + * `5g-112-5560-20` - 112 (5560/20 MHz) + * `5g-114-5570-160` - 114 (5570/160 MHz) + * `5g-116-5580-20` - 116 (5580/20 MHz) + * `5g-118-5590-40` - 118 (5590/40 MHz) + * `5g-120-5600-20` - 120 (5600/20 MHz) + * `5g-122-5610-80` - 122 (5610/80 MHz) + * `5g-124-5620-20` - 124 (5620/20 MHz) + * `5g-126-5630-40` - 126 (5630/40 MHz) + * `5g-128-5640-20` - 128 (5640/20 MHz) + * `5g-132-5660-20` - 132 (5660/20 MHz) + * `5g-134-5670-40` - 134 (5670/40 MHz) + * `5g-136-5680-20` - 136 (5680/20 MHz) + * `5g-138-5690-80` - 138 (5690/80 MHz) + * `5g-140-5700-20` - 140 (5700/20 MHz) + * `5g-142-5710-40` - 142 (5710/40 MHz) + * `5g-144-5720-20` - 144 (5720/20 MHz) + * `5g-149-5745-20` - 149 (5745/20 MHz) + * `5g-151-5755-40` - 151 (5755/40 MHz) + * `5g-153-5765-20` - 153 (5765/20 MHz) + * `5g-155-5775-80` - 155 (5775/80 MHz) + * `5g-157-5785-20` - 157 (5785/20 MHz) + * `5g-159-5795-40` - 159 (5795/40 MHz) + * `5g-161-5805-20` - 161 (5805/20 MHz) + * `5g-163-5815-160` - 163 (5815/160 MHz) + * `5g-165-5825-20` - 165 (5825/20 MHz) + * `5g-167-5835-40` - 167 (5835/40 MHz) + * `5g-169-5845-20` - 169 (5845/20 MHz) + * `5g-171-5855-80` - 171 (5855/80 MHz) + * `5g-173-5865-20` - 173 (5865/20 MHz) + * `5g-175-5875-40` - 175 (5875/40 MHz) + * `5g-177-5885-20` - 177 (5885/20 MHz) + * `6g-1-5955-20` - 1 (5955/20 MHz) + * `6g-3-5965-40` - 3 (5965/40 MHz) + * `6g-5-5975-20` - 5 (5975/20 MHz) + * `6g-7-5985-80` - 7 (5985/80 MHz) + * `6g-9-5995-20` - 9 (5995/20 MHz) + * `6g-11-6005-40` - 11 (6005/40 MHz) + * `6g-13-6015-20` - 13 (6015/20 MHz) + * `6g-15-6025-160` - 15 (6025/160 MHz) + * `6g-17-6035-20` - 17 (6035/20 MHz) + * `6g-19-6045-40` - 19 (6045/40 MHz) + * `6g-21-6055-20` - 21 (6055/20 MHz) + * `6g-23-6065-80` - 23 (6065/80 MHz) + * `6g-25-6075-20` - 25 (6075/20 MHz) + * `6g-27-6085-40` - 27 (6085/40 MHz) + * `6g-29-6095-20` - 29 (6095/20 MHz) + * `6g-31-6105-320` - 31 (6105/320 MHz) + * `6g-33-6115-20` - 33 (6115/20 MHz) + * `6g-35-6125-40` - 35 (6125/40 MHz) + * `6g-37-6135-20` - 37 (6135/20 MHz) + * `6g-39-6145-80` - 39 (6145/80 MHz) + * `6g-41-6155-20` - 41 (6155/20 MHz) + * `6g-43-6165-40` - 43 (6165/40 MHz) + * `6g-45-6175-20` - 45 (6175/20 MHz) + * `6g-47-6185-160` - 47 (6185/160 MHz) + * `6g-49-6195-20` - 49 (6195/20 MHz) + * `6g-51-6205-40` - 51 (6205/40 MHz) + * `6g-53-6215-20` - 53 (6215/20 MHz) + * `6g-55-6225-80` - 55 (6225/80 MHz) + * `6g-57-6235-20` - 57 (6235/20 MHz) + * `6g-59-6245-40` - 59 (6245/40 MHz) + * `6g-61-6255-20` - 61 (6255/20 MHz) + * `6g-65-6275-20` - 65 (6275/20 MHz) + * `6g-67-6285-40` - 67 (6285/40 MHz) + * `6g-69-6295-20` - 69 (6295/20 MHz) + * `6g-71-6305-80` - 71 (6305/80 MHz) + * `6g-73-6315-20` - 73 (6315/20 MHz) + * `6g-75-6325-40` - 75 (6325/40 MHz) + * `6g-77-6335-20` - 77 (6335/20 MHz) + * `6g-79-6345-160` - 79 (6345/160 MHz) + * `6g-81-6355-20` - 81 (6355/20 MHz) + * `6g-83-6365-40` - 83 (6365/40 MHz) + * `6g-85-6375-20` - 85 (6375/20 MHz) + * `6g-87-6385-80` - 87 (6385/80 MHz) + * `6g-89-6395-20` - 89 (6395/20 MHz) + * `6g-91-6405-40` - 91 (6405/40 MHz) + * `6g-93-6415-20` - 93 (6415/20 MHz) + * `6g-95-6425-320` - 95 (6425/320 MHz) + * `6g-97-6435-20` - 97 (6435/20 MHz) + * `6g-99-6445-40` - 99 (6445/40 MHz) + * `6g-101-6455-20` - 101 (6455/20 MHz) + * `6g-103-6465-80` - 103 (6465/80 MHz) + * `6g-105-6475-20` - 105 (6475/20 MHz) + * `6g-107-6485-40` - 107 (6485/40 MHz) + * `6g-109-6495-20` - 109 (6495/20 MHz) + * `6g-111-6505-160` - 111 (6505/160 MHz) + * `6g-113-6515-20` - 113 (6515/20 MHz) + * `6g-115-6525-40` - 115 (6525/40 MHz) + * `6g-117-6535-20` - 117 (6535/20 MHz) + * `6g-119-6545-80` - 119 (6545/80 MHz) + * `6g-121-6555-20` - 121 (6555/20 MHz) + * `6g-123-6565-40` - 123 (6565/40 MHz) + * `6g-125-6575-20` - 125 (6575/20 MHz) + * `6g-129-6595-20` - 129 (6595/20 MHz) + * `6g-131-6605-40` - 131 (6605/40 MHz) + * `6g-133-6615-20` - 133 (6615/20 MHz) + * `6g-135-6625-80` - 135 (6625/80 MHz) + * `6g-137-6635-20` - 137 (6635/20 MHz) + * `6g-139-6645-40` - 139 (6645/40 MHz) + * `6g-141-6655-20` - 141 (6655/20 MHz) + * `6g-143-6665-160` - 143 (6665/160 MHz) + * `6g-145-6675-20` - 145 (6675/20 MHz) + * `6g-147-6685-40` - 147 (6685/40 MHz) + * `6g-149-6695-20` - 149 (6695/20 MHz) + * `6g-151-6705-80` - 151 (6705/80 MHz) + * `6g-153-6715-20` - 153 (6715/20 MHz) + * `6g-155-6725-40` - 155 (6725/40 MHz) + * `6g-157-6735-20` - 157 (6735/20 MHz) + * `6g-159-6745-320` - 159 (6745/320 MHz) + * `6g-161-6755-20` - 161 (6755/20 MHz) + * `6g-163-6765-40` - 163 (6765/40 MHz) + * `6g-165-6775-20` - 165 (6775/20 MHz) + * `6g-167-6785-80` - 167 (6785/80 MHz) + * `6g-169-6795-20` - 169 (6795/20 MHz) + * `6g-171-6805-40` - 171 (6805/40 MHz) + * `6g-173-6815-20` - 173 (6815/20 MHz) + * `6g-175-6825-160` - 175 (6825/160 MHz) + * `6g-177-6835-20` - 177 (6835/20 MHz) + * `6g-179-6845-40` - 179 (6845/40 MHz) + * `6g-181-6855-20` - 181 (6855/20 MHz) + * `6g-183-6865-80` - 183 (6865/80 MHz) + * `6g-185-6875-20` - 185 (6875/20 MHz) + * `6g-187-6885-40` - 187 (6885/40 MHz) + * `6g-189-6895-20` - 189 (6895/20 MHz) + * `6g-193-6915-20` - 193 (6915/20 MHz) + * `6g-195-6925-40` - 195 (6925/40 MHz) + * `6g-197-6935-20` - 197 (6935/20 MHz) + * `6g-199-6945-80` - 199 (6945/80 MHz) + * `6g-201-6955-20` - 201 (6955/20 MHz) + * `6g-203-6965-40` - 203 (6965/40 MHz) + * `6g-205-6975-20` - 205 (6975/20 MHz) + * `6g-207-6985-160` - 207 (6985/160 MHz) + * `6g-209-6995-20` - 209 (6995/20 MHz) + * `6g-211-7005-40` - 211 (7005/40 MHz) + * `6g-213-7015-20` - 213 (7015/20 MHz) + * `6g-215-7025-80` - 215 (7025/80 MHz) + * `6g-217-7035-20` - 217 (7035/20 MHz) + * `6g-219-7045-40` - 219 (7045/40 MHz) + * `6g-221-7055-20` - 221 (7055/20 MHz) + * `6g-225-7075-20` - 225 (7075/20 MHz) + * `6g-227-7085-40` - 227 (7085/40 MHz) + * `6g-229-7095-20` - 229 (7095/20 MHz) + * `6g-233-7115-20` - 233 (7115/20 MHz) + * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) + * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) + * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) + * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) + * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) + * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) + * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) + * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) + * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) + * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) + * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) + * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) + * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) + * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) + * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) + * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) + * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) + * `60g-27-65880-6480` - 27 (65.88/8.64 GHz) + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + poe_mode: + enum: + - pd + - pse + - '' + - null + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + poe_type: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + - null + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + nullable: true + rf_channel_frequency: + type: number + format: double + maximum: 100000 + minimum: -100000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel frequency (MHz) + description: Populated by selected channel (if set) + rf_channel_width: + type: number + format: double + maximum: 10000 + minimum: -10000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel width (MHz) + description: Populated by selected channel (if set) + tx_power: + type: integer + maximum: 127 + minimum: -40 + nullable: true + title: Transmit power (dBm) + untagged_vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + tagged_vlans: + type: array + items: + type: integer + qinq_svlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + vlan_translation_policy: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' + nullable: true + nullable: true + mark_connected: + type: boolean + description: Treat as if a cable is connected + wireless_lans: + type: array + items: + type: integer + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableInterfaceTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + enabled: + type: boolean + mgmt_only: + type: boolean + title: Management only + description: + type: string + maxLength: 200 + bridge: + type: integer + nullable: true + title: Bridge interface + poe_mode: + enum: + - pd + - pse + - '' + - null + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + poe_type: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + - null + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + nullable: true + rf_role: + enum: + - ap + - station + - '' + - null + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + PatchedWritableInventoryItemRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + parent: + type: integer + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + part_id: + type: string + description: Manufacturer-assigned part identifier + maxLength: 50 + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this item + maxLength: 50 + discovered: + type: boolean + description: This item was automatically discovered + description: + type: string + maxLength: 200 + component_type: + type: string + nullable: true + component_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableJournalEntryRequest: + type: object + description: Adds support for custom fields and tags. + properties: + assigned_object_type: + type: string + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + created_by: + type: integer + nullable: true + kind: + enum: + - info + - success + - warning + - danger + type: string + description: |- + * `info` - Info + * `success` - Success + * `warning` - Warning + * `danger` - Danger + x-spec-enum-id: 6f65abe0aab2c78c + comments: + type: string + minLength: 1 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableL2VPNRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + identifier: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + type: + enum: + - vpws + - vpls + - vxlan + - vxlan-evpn + - mpls-evpn + - pbb-evpn + - evpn-vpws + - epl + - evpl + - ep-lan + - evp-lan + - ep-tree + - evp-tree + - spb + type: string + description: |- + * `vpws` - VPWS + * `vpls` - VPLS + * `vxlan` - VXLAN + * `vxlan-evpn` - VXLAN-EVPN + * `mpls-evpn` - MPLS EVPN + * `pbb-evpn` - PBB EVPN + * `evpn-vpws` - EVPN VPWS + * `epl` - EPL + * `evpl` - EVPL + * `ep-lan` - Ethernet Private LAN + * `evp-lan` - Ethernet Virtual Private LAN + * `ep-tree` - Ethernet Private Tree + * `evp-tree` - Ethernet Virtual Private Tree + * `spb` - SPB + x-spec-enum-id: 0a46f8056d717efc + status: + enum: + - active + - planned + - decommissioning + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 8b9dc8efc7c3d5b0 + import_targets: + type: array + items: + type: integer + export_targets: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableLocationRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + parent: + type: integer + nullable: true + status: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableModuleRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module_bay: + type: integer + module_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefModuleTypeRequest' + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + replicate_components: + type: boolean + writeOnly: true + default: true + description: 'Automatically populate components associated with this module + type (default: true)' + adopt_components: + type: boolean + writeOnly: true + default: false + description: Adopt already existing components + PatchedWritableModuleTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - passive + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `passive` - Passive + x-spec-enum-id: 5ad4e700c656b09d + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + description: + type: string + maxLength: 200 + attributes: + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritablePlatformRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + parent: + type: integer + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritablePowerFeedRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + power_panel: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefPowerPanelRequest' + rack: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + status: + enum: + - offline + - active + - planned + - failed + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `failed` - Failed + x-spec-enum-id: ec530572dc778583 + type: + enum: + - primary + - redundant + type: string + description: |- + * `primary` - Primary + * `redundant` - Redundant + x-spec-enum-id: 093a164236819eb8 + supply: + enum: + - ac + - dc + type: string + description: |- + * `ac` - AC + * `dc` - DC + x-spec-enum-id: 1b6d99616ca6412b + phase: + enum: + - single-phase + - three-phase + type: string + description: |- + * `single-phase` - Single phase + * `three-phase` - Three-phase + x-spec-enum-id: 994bc0696f4df57f + voltage: + type: integer + maximum: 32767 + minimum: -32768 + amperage: + type: integer + maximum: 32767 + minimum: 1 + max_utilization: + type: integer + maximum: 100 + minimum: 1 + description: Maximum permissible draw (percentage) + mark_connected: + type: boolean + description: Treat as if a cable is connected + description: + type: string + maxLength: 200 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritablePowerOutletRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: |- + Physical port type + + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + status: + enum: + - enabled + - disabled + - faulty + type: string + description: |- + * `enabled` - Enabled + * `disabled` - Disabled + * `faulty` - Faulty + x-spec-enum-id: d60dce16858f3c69 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPowerPortRequest' + nullable: true + nullable: true + feed_leg: + enum: + - A + - B + - C + - '' + - null + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: |- + Phase (for three-phase feeds) + + * `A` - A + * `B` - B + * `C` - C + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritablePowerOutletTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPowerPortTemplateRequest' + nullable: true + nullable: true + feed_leg: + enum: + - A + - B + - C + - '' + - null + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: |- + Phase (for three-phase feeds) + + * `A` - A + * `B` - B + * `C` - C + description: + type: string + maxLength: 200 + PatchedWritablePowerPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: |- + Physical port type + + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritablePowerPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + PatchedWritablePrefixRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + prefix: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + status: + enum: + - container + - active + - reserved + - deprecated + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: |- + Operational status of this prefix + + * `container` - Container + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + is_pool: + type: boolean + title: Is a pool + description: All IP addresses within this prefix are considered usable + mark_utilized: + type: boolean + description: Treat as fully utilized + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableRackRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + facility_id: + type: string + nullable: true + maxLength: 50 + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackGroupRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - reserved + - available + - planned + - active + - deprecated + type: string + description: |- + * `reserved` - Reserved + * `available` - Available + * `planned` - Planned + * `active` - Active + * `deprecated` - Deprecated + x-spec-enum-id: 76eea4eef8804bcb + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRoleRequest' + nullable: true + nullable: true + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this rack + maxLength: 50 + rack_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackTypeRequest' + nullable: true + nullable: true + form_factor: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + - '' + - null + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + nullable: true + width: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: |- + Rail-to-rail width + + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + minimum: 0 + maximum: 32767 + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + airflow: + enum: + - front-to-rear + - rear-to-front + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + x-spec-enum-id: a784734d07ef1b3c + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableRackReservationRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + rack: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRackRequest' + units: + type: array + items: + type: integer + maximum: 32767 + minimum: 0 + status: + enum: + - pending + - active + - stale + type: string + description: |- + * `pending` - Pending + * `active` - Active + * `stale` - Stale + x-spec-enum-id: ed6038a4deee151c + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + minLength: 1 + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableRackTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + form_factor: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + width: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: |- + Rail-to-rail width + + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + minimum: 0 + maximum: 32767 + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableRearPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortMappingRequest' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableRearPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateMappingRequest' + description: + type: string + maxLength: 200 + PatchedWritableRegionRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableServiceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + parent_object_type: + type: string + parent_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + name: + type: string + minLength: 1 + maxLength: 100 + protocol: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + ipaddresses: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableServiceTemplateRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + protocol: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableSiteGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableSiteRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Full name of the site + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + status: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + region: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRegionRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteGroupRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + time_zone: + type: string + nullable: true + minLength: 1 + description: + type: string + maxLength: 200 + physical_address: + type: string + description: Physical location of the building + maxLength: 200 + shipping_address: + type: string + description: If different from the physical address + maxLength: 200 + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + asns: + type: array + items: + type: integer + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableTenantGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableTunnelRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + status: + enum: + - planned + - active + - disabled + type: string + description: |- + * `planned` - Planned + * `active` - Active + * `disabled` - Disabled + x-spec-enum-id: 2431ef62c418f485 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTunnelGroupRequest' + nullable: true + nullable: true + encapsulation: + enum: + - ipsec-transport + - ipsec-tunnel + - ip-ip + - gre + - wireguard + - openvpn + - l2tp + - pptp + type: string + description: |- + * `ipsec-transport` - IPsec - Transport + * `ipsec-tunnel` - IPsec - Tunnel + * `ip-ip` - IP-in-IP + * `gre` - GRE + * `wireguard` - WireGuard + * `openvpn` - OpenVPN + * `l2tp` - L2TP + * `pptp` - PPTP + x-spec-enum-id: 4f3254459f0e94f0 + ipsec_profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPSecProfileRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + tunnel_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableTunnelTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + tunnel: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefTunnelRequest' + role: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + termination_type: + type: string + termination_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + outside_ip: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableVLANRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + site: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANGroupRequest' + nullable: true + nullable: true + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + minLength: 1 + maxLength: 64 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + type: string + x-spec-enum-id: ca933c38b935e547 + description: |- + Operational status of this VLAN + + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + qinq_role: + enum: + - svlan + - cvlan + - '' + - null + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: |- + Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + + * `svlan` - Service + * `cvlan` - Customer + qinq_svlan: + type: integer + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableVMInterfaceRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + virtual_machine: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualMachineRequest' + name: + type: string + minLength: 1 + maxLength: 64 + enabled: + type: boolean + parent: + type: integer + nullable: true + title: Parent interface + bridge: + type: integer + nullable: true + title: Bridge interface + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + primary_mac_address: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefMACAddressRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + mode: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + - null + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: |- + IEEE 802.1Q tagging strategy + + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + untagged_vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + tagged_vlans: + type: array + items: + type: integer + qinq_svlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + vlan_translation_policy: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' + nullable: true + nullable: true + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableVirtualChassisRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + domain: + type: string + maxLength: 30 + master: + type: integer + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableVirtualCircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider_network: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderNetworkRequest' + provider_account: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefProviderAccountRequest' + nullable: true + nullable: true + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualCircuitTypeRequest' + status: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableVirtualCircuitTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + virtual_circuit: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualCircuitRequest' + role: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + interface: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableVirtualDeviceContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + identifier: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + status: + enum: + - active + - planned + - offline + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `offline` - Offline + x-spec-enum-id: 0e2c0919d51b83cb + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableVirtualMachineWithConfigContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + virtual_machine_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVirtualMachineTypeRequest' + nullable: true + nullable: true + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRoleRequest' + nullable: true + nullable: true + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + - paused + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + * `paused` - Paused + x-spec-enum-id: effecc3b94e0b74b + start_on_boot: + enum: + - 'on' + - 'off' + - laststate + type: string + description: |- + * `on` - On + * `off` - Off + * `laststate` - Last State + x-spec-enum-id: 610e33fc2fde73d6 + site: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteRequest' + nullable: true + nullable: true + cluster: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterRequest' + nullable: true + nullable: true + device: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRequest' + nullable: true + nullable: true + platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + vcpus: + type: number + format: double + maximum: 10000 + minimum: 0.01000000000000000020816681711721685132943093776702880859375 + exclusiveMaximum: true + nullable: true + memory: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + disk: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: + type: string + maxLength: 200 + serial: + type: string + title: Serial number + maxLength: 50 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + custom_fields: + type: object + additionalProperties: {} + PatchedWritableWirelessLANGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + PatchedWritableWirelessLANRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + ssid: + type: string + minLength: 1 + maxLength: 32 + description: + type: string + maxLength: 200 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefWirelessLANGroupRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - disabled + - deprecated + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `disabled` - Disabled + * `deprecated` - Deprecated + x-spec-enum-id: e5549d7370ce2e6c + vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + auth_type: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + - null + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + auth_cipher: + enum: + - auto + - tkip + - aes + - '' + - null + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + PatchedWritableWirelessLinkRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + interface_a: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + interface_b: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + ssid: + type: string + maxLength: 32 + status: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + auth_type: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + - null + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + auth_cipher: + enum: + - auto + - tkip + - aes + - '' + - null + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + Platform: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + parent: + allOf: + - $ref: '#/components/schemas/NestedPlatform' + nullable: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + manufacturer: + allOf: + - $ref: '#/components/schemas/BriefManufacturer' + nullable: true + config_template: + allOf: + - $ref: '#/components/schemas/BriefConfigTemplate' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + device_count: + type: integer + readOnly: true + default: 0 + virtualmachine_count: + type: integer + readOnly: true + default: 0 + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - created + - device_count + - display + - display_url + - id + - last_updated + - name + - slug + - url + - virtualmachine_count + PlatformRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + parent: + allOf: + - $ref: '#/components/schemas/NestedPlatformRequest' + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + PowerFeed: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + power_panel: + $ref: '#/components/schemas/BriefPowerPanel' + rack: + allOf: + - $ref: '#/components/schemas/BriefRack' + nullable: true + name: + type: string + maxLength: 100 + status: + type: object + properties: + value: + enum: + - offline + - active + - planned + - failed + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `failed` - Failed + x-spec-enum-id: ec530572dc778583 + label: + type: string + enum: + - Offline + - Active + - Planned + - Failed + type: + type: object + properties: + value: + enum: + - primary + - redundant + type: string + description: |- + * `primary` - Primary + * `redundant` - Redundant + x-spec-enum-id: 093a164236819eb8 + label: + type: string + enum: + - Primary + - Redundant + supply: + type: object + properties: + value: + enum: + - ac + - dc + type: string + description: |- + * `ac` - AC + * `dc` - DC + x-spec-enum-id: 1b6d99616ca6412b + label: + type: string + enum: + - AC + - DC + phase: + type: object + properties: + value: + enum: + - single-phase + - three-phase + type: string + description: |- + * `single-phase` - Single phase + * `three-phase` - Three-phase + x-spec-enum-id: 994bc0696f4df57f + label: + type: string + enum: + - Single phase + - Three-phase + voltage: + type: integer + maximum: 32767 + minimum: -32768 + amperage: + type: integer + maximum: 32767 + minimum: 1 + max_utilization: + type: integer + maximum: 100 + minimum: 1 + description: Maximum permissible draw (percentage) + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + connected_endpoints: + type: array + items: {} + nullable: true + readOnly: true + connected_endpoints_type: + type: string + readOnly: true + nullable: true + connected_endpoints_reachable: + type: boolean + readOnly: true + description: + type: string + maxLength: 200 + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - connected_endpoints + - connected_endpoints_reachable + - connected_endpoints_type + - created + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - name + - power_panel + - url + PowerFeedRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + power_panel: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefPowerPanelRequest' + rack: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + status: + enum: + - offline + - active + - planned + - failed + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `failed` - Failed + x-spec-enum-id: ec530572dc778583 + type: + enum: + - primary + - redundant + type: string + description: |- + * `primary` - Primary + * `redundant` - Redundant + x-spec-enum-id: 093a164236819eb8 + supply: + enum: + - ac + - dc + type: string + description: |- + * `ac` - AC + * `dc` - DC + x-spec-enum-id: 1b6d99616ca6412b + phase: + enum: + - single-phase + - three-phase + type: string + description: |- + * `single-phase` - Single phase + * `three-phase` - Three-phase + x-spec-enum-id: 994bc0696f4df57f + voltage: + type: integer + maximum: 32767 + minimum: -32768 + amperage: + type: integer + maximum: 32767 + minimum: 1 + max_utilization: + type: integer + maximum: 100 + minimum: 1 + description: Maximum permissible draw (percentage) + mark_connected: + type: boolean + description: Treat as if a cable is connected + description: + type: string + maxLength: 200 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - power_panel + PowerOutlet: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: db3e4eb2b93615f8 + label: + type: string + enum: + - C5 + - C7 + - C13 + - C15 + - C17 + - C19 + - C21 + - P+N+E 4H + - P+N+E 6H + - P+N+E 9H + - 2P+E 4H + - 2P+E 6H + - 2P+E 9H + - 3P+E 4H + - 3P+E 6H + - 3P+E 9H + - 3P+N+E 4H + - 3P+N+E 6H + - 3P+N+E 9H + - IEC 60906-1 + - 2P+T 10A (NBR 14136) + - 2P+T 20A (NBR 14136) + - NEMA 1-15R + - NEMA 5-15R + - NEMA 5-20R + - NEMA 5-30R + - NEMA 5-50R + - NEMA 6-15R + - NEMA 6-20R + - NEMA 6-30R + - NEMA 6-50R + - NEMA 10-30R + - NEMA 10-50R + - NEMA 14-20R + - NEMA 14-30R + - NEMA 14-50R + - NEMA 14-60R + - NEMA 15-15R + - NEMA 15-20R + - NEMA 15-30R + - NEMA 15-50R + - NEMA 15-60R + - NEMA L1-15R + - NEMA L5-15R + - NEMA L5-20R + - NEMA L5-30R + - NEMA L5-50R + - NEMA L6-15R + - NEMA L6-20R + - NEMA L6-30R + - NEMA L6-50R + - NEMA L10-30R + - NEMA L14-20R + - NEMA L14-30R + - NEMA L14-50R + - NEMA L14-60R + - NEMA L15-20R + - NEMA L15-30R + - NEMA L15-50R + - NEMA L15-60R + - NEMA L21-20R + - NEMA L21-30R + - NEMA L22-20R + - NEMA L22-30R + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ITA Type E (CEE 7/5) + - ITA Type F (CEE 7/3) + - ITA Type G (BS 1363) + - ITA Type H + - ITA Type I + - ITA Type J + - ITA Type K + - ITA Type L (CEI 23-50) + - ITA Type M (BS 546) + - ITA Type N + - ITA Type O + - ITA Multistandard + - USB Type A + - USB Micro B + - USB Type C + - Molex Micro-Fit 1x2 + - Molex Micro-Fit 2x2 + - Molex Micro-Fit 2x3 + - Molex Micro-Fit 2x4 + - DC Terminal + - Eaton C39 + - HDOT Cx + - Saf-D-Grid + - Neutrik powerCON (20A) + - Neutrik powerCON (32A) + - Neutrik powerCON TRUE1 + - Neutrik powerCON TRUE1 TOP + - Ubiquiti SmartPower + - Hardwired + - Other + nullable: true + status: + type: object + properties: + value: + enum: + - enabled + - disabled + - faulty + type: string + description: |- + * `enabled` - Enabled + * `disabled` - Disabled + * `faulty` - Faulty + x-spec-enum-id: d60dce16858f3c69 + label: + type: string + enum: + - Enabled + - Disabled + - Faulty + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + allOf: + - $ref: '#/components/schemas/BriefPowerPort' + nullable: true + feed_leg: + type: object + properties: + value: + enum: + - A + - B + - C + - '' + - null + type: string + description: |- + * `A` - A + * `B` - B + * `C` - C + x-spec-enum-id: a4902339df0b7c06 + label: + type: string + enum: + - A + - B + - C + nullable: true + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + connected_endpoints: + type: array + items: {} + nullable: true + readOnly: true + connected_endpoints_type: + type: string + readOnly: true + nullable: true + connected_endpoints_reachable: + type: boolean + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - connected_endpoints + - connected_endpoints_reachable + - connected_endpoints_type + - created + - device + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - name + - url + PowerOutletRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + status: + enum: + - enabled + - disabled + - faulty + type: string + description: |- + * `enabled` - Enabled + * `disabled` - Disabled + * `faulty` - Faulty + x-spec-enum-id: d60dce16858f3c69 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPowerPortRequest' + nullable: true + nullable: true + feed_leg: + enum: + - A + - B + - C + - '' + - null + type: string + description: |- + * `A` - A + * `B` - B + * `C` - C + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + PowerOutletTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: db3e4eb2b93615f8 + label: + type: string + enum: + - C5 + - C7 + - C13 + - C15 + - C17 + - C19 + - C21 + - P+N+E 4H + - P+N+E 6H + - P+N+E 9H + - 2P+E 4H + - 2P+E 6H + - 2P+E 9H + - 3P+E 4H + - 3P+E 6H + - 3P+E 9H + - 3P+N+E 4H + - 3P+N+E 6H + - 3P+N+E 9H + - IEC 60906-1 + - 2P+T 10A (NBR 14136) + - 2P+T 20A (NBR 14136) + - NEMA 1-15R + - NEMA 5-15R + - NEMA 5-20R + - NEMA 5-30R + - NEMA 5-50R + - NEMA 6-15R + - NEMA 6-20R + - NEMA 6-30R + - NEMA 6-50R + - NEMA 10-30R + - NEMA 10-50R + - NEMA 14-20R + - NEMA 14-30R + - NEMA 14-50R + - NEMA 14-60R + - NEMA 15-15R + - NEMA 15-20R + - NEMA 15-30R + - NEMA 15-50R + - NEMA 15-60R + - NEMA L1-15R + - NEMA L5-15R + - NEMA L5-20R + - NEMA L5-30R + - NEMA L5-50R + - NEMA L6-15R + - NEMA L6-20R + - NEMA L6-30R + - NEMA L6-50R + - NEMA L10-30R + - NEMA L14-20R + - NEMA L14-30R + - NEMA L14-50R + - NEMA L14-60R + - NEMA L15-20R + - NEMA L15-30R + - NEMA L15-50R + - NEMA L15-60R + - NEMA L21-20R + - NEMA L21-30R + - NEMA L22-20R + - NEMA L22-30R + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ITA Type E (CEE 7/5) + - ITA Type F (CEE 7/3) + - ITA Type G (BS 1363) + - ITA Type H + - ITA Type I + - ITA Type J + - ITA Type K + - ITA Type L (CEI 23-50) + - ITA Type M (BS 546) + - ITA Type N + - ITA Type O + - ITA Multistandard + - USB Type A + - USB Micro B + - USB Type C + - Molex Micro-Fit 1x2 + - Molex Micro-Fit 2x2 + - Molex Micro-Fit 2x3 + - Molex Micro-Fit 2x4 + - DC Terminal + - Eaton C39 + - HDOT Cx + - Saf-D-Grid + - Neutrik powerCON (20A) + - Neutrik powerCON (32A) + - Neutrik powerCON TRUE1 + - Neutrik powerCON TRUE1 TOP + - Ubiquiti SmartPower + - Hardwired + - Other + nullable: true + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + allOf: + - $ref: '#/components/schemas/BriefPowerPortTemplate' + nullable: true + feed_leg: + type: object + properties: + value: + enum: + - A + - B + - C + - '' + - null + type: string + description: |- + * `A` - A + * `B` - B + * `C` - C + x-spec-enum-id: a4902339df0b7c06 + label: + type: string + enum: + - A + - B + - C + nullable: true + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - url + PowerOutletTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPowerPortTemplateRequest' + nullable: true + nullable: true + feed_leg: + enum: + - A + - B + - C + - '' + - null + type: string + description: |- + * `A` - A + * `B` - B + * `C` - C + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: + type: string + maxLength: 200 + required: + - name + PowerPanel: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + site: + $ref: '#/components/schemas/BriefSite' + location: + allOf: + - $ref: '#/components/schemas/BriefLocation' + nullable: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + powerfeed_count: + type: integer + format: int64 + readOnly: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - powerfeed_count + - site + - url + PowerPanelRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - site + PowerPort: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: aadcbe6ca854c1ed + label: + type: string + enum: + - C6 + - C8 + - C14 + - C16 + - C18 + - C20 + - C22 + - P+N+E 4H + - P+N+E 6H + - P+N+E 9H + - 2P+E 4H + - 2P+E 6H + - 2P+E 9H + - 3P+E 4H + - 3P+E 6H + - 3P+E 9H + - 3P+N+E 4H + - 3P+N+E 6H + - 3P+N+E 9H + - IEC 60906-1 + - 2P+T 10A (NBR 14136) + - 2P+T 20A (NBR 14136) + - NEMA 1-15P + - NEMA 5-15P + - NEMA 5-20P + - NEMA 5-30P + - NEMA 5-50P + - NEMA 6-15P + - NEMA 6-20P + - NEMA 6-30P + - NEMA 6-50P + - NEMA 10-30P + - NEMA 10-50P + - NEMA 14-20P + - NEMA 14-30P + - NEMA 14-50P + - NEMA 14-60P + - NEMA 15-15P + - NEMA 15-20P + - NEMA 15-30P + - NEMA 15-50P + - NEMA 15-60P + - NEMA L1-15P + - NEMA L5-15P + - NEMA L5-20P + - NEMA L5-30P + - NEMA L5-50P + - NEMA L6-15P + - NEMA L6-20P + - NEMA L6-30P + - NEMA L6-50P + - NEMA L10-30P + - NEMA L14-20P + - NEMA L14-30P + - NEMA L14-50P + - NEMA L14-60P + - NEMA L15-20P + - NEMA L15-30P + - NEMA L15-50P + - NEMA L15-60P + - NEMA L21-20P + - NEMA L21-30P + - NEMA L22-20P + - NEMA L22-30P + - CS6361C + - CS6365C + - CS8165C + - CS8265C + - CS8365C + - CS8465C + - ITA Type C (CEE 7/16) + - ITA Type E (CEE 7/6) + - ITA Type F (CEE 7/4) + - ITA Type E/F (CEE 7/7) + - ITA Type G (BS 1363) + - ITA Type H + - ITA Type I + - ITA Type J + - ITA Type K + - ITA Type L (CEI 23-50) + - ITA Type M (BS 546) + - ITA Type N + - ITA Type O + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - USB 3.0 Type B + - USB 3.0 Micro B + - Molex Micro-Fit 1x2 + - Molex Micro-Fit 2x2 + - Molex Micro-Fit 2x3 + - Molex Micro-Fit 2x4 + - DC Terminal + - Saf-D-Grid + - Neutrik powerCON (20A) + - Neutrik powerCON (32A) + - Neutrik powerCON TRUE1 + - Neutrik powerCON TRUE1 TOP + - Ubiquiti SmartPower + - Hardwired + - Other + nullable: true + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + connected_endpoints: + type: array + items: {} + nullable: true + readOnly: true + connected_endpoints_type: + type: string + readOnly: true + nullable: true + connected_endpoints_reachable: + type: boolean + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - connected_endpoints + - connected_endpoints_reachable + - connected_endpoints_type + - created + - device + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - name + - url + PowerPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + PowerPortTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: aadcbe6ca854c1ed + label: + type: string + enum: + - C6 + - C8 + - C14 + - C16 + - C18 + - C20 + - C22 + - P+N+E 4H + - P+N+E 6H + - P+N+E 9H + - 2P+E 4H + - 2P+E 6H + - 2P+E 9H + - 3P+E 4H + - 3P+E 6H + - 3P+E 9H + - 3P+N+E 4H + - 3P+N+E 6H + - 3P+N+E 9H + - IEC 60906-1 + - 2P+T 10A (NBR 14136) + - 2P+T 20A (NBR 14136) + - NEMA 1-15P + - NEMA 5-15P + - NEMA 5-20P + - NEMA 5-30P + - NEMA 5-50P + - NEMA 6-15P + - NEMA 6-20P + - NEMA 6-30P + - NEMA 6-50P + - NEMA 10-30P + - NEMA 10-50P + - NEMA 14-20P + - NEMA 14-30P + - NEMA 14-50P + - NEMA 14-60P + - NEMA 15-15P + - NEMA 15-20P + - NEMA 15-30P + - NEMA 15-50P + - NEMA 15-60P + - NEMA L1-15P + - NEMA L5-15P + - NEMA L5-20P + - NEMA L5-30P + - NEMA L5-50P + - NEMA L6-15P + - NEMA L6-20P + - NEMA L6-30P + - NEMA L6-50P + - NEMA L10-30P + - NEMA L14-20P + - NEMA L14-30P + - NEMA L14-50P + - NEMA L14-60P + - NEMA L15-20P + - NEMA L15-30P + - NEMA L15-50P + - NEMA L15-60P + - NEMA L21-20P + - NEMA L21-30P + - NEMA L22-20P + - NEMA L22-30P + - CS6361C + - CS6365C + - CS8165C + - CS8265C + - CS8365C + - CS8465C + - ITA Type C (CEE 7/16) + - ITA Type E (CEE 7/6) + - ITA Type F (CEE 7/4) + - ITA Type E/F (CEE 7/7) + - ITA Type G (BS 1363) + - ITA Type H + - ITA Type I + - ITA Type J + - ITA Type K + - ITA Type L (CEI 23-50) + - ITA Type M (BS 546) + - ITA Type N + - ITA Type O + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - USB 3.0 Type B + - USB 3.0 Micro B + - Molex Micro-Fit 1x2 + - Molex Micro-Fit 2x2 + - Molex Micro-Fit 2x3 + - Molex Micro-Fit 2x4 + - DC Terminal + - Saf-D-Grid + - Neutrik powerCON (20A) + - Neutrik powerCON (32A) + - Neutrik powerCON TRUE1 + - Neutrik powerCON TRUE1 TOP + - Ubiquiti SmartPower + - Hardwired + - Other + nullable: true + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - url + PowerPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + required: + - name + Prefix: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + family: + type: object + properties: + value: + enum: + - 4 + - 6 + type: integer + description: |- + * `4` - IPv4 + * `6` - IPv6 + x-spec-enum-id: d72003fd1af3603d + label: + type: string + enum: + - IPv4 + - IPv6 + readOnly: true + prefix: + type: string + vrf: + allOf: + - $ref: '#/components/schemas/BriefVRF' + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + scope: + readOnly: true + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + vlan: + allOf: + - $ref: '#/components/schemas/BriefVLAN' + nullable: true + status: + type: object + properties: + value: + enum: + - container + - active + - reserved + - deprecated + type: string + description: |- + * `container` - Container + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + x-spec-enum-id: 026173ce39f2ee63 + label: + type: string + enum: + - Container + - Active + - Reserved + - Deprecated + role: + allOf: + - $ref: '#/components/schemas/BriefRole' + nullable: true + is_pool: + type: boolean + title: Is a pool + description: All IP addresses within this prefix are considered usable + mark_utilized: + type: boolean + description: Treat as fully utilized + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + children: + type: integer + readOnly: true + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - children + - created + - display + - display_url + - family + - id + - last_updated + - prefix + - scope + - url + PrefixLengthRequest: + type: object + properties: + prefix_length: + type: integer + required: + - prefix_length + PrefixRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + prefix: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + status: + enum: + - container + - active + - reserved + - deprecated + type: string + description: |- + * `container` - Container + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + x-spec-enum-id: 026173ce39f2ee63 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + is_pool: + type: boolean + title: Is a pool + description: All IP addresses within this prefix are considered usable + mark_utilized: + type: boolean + description: Treat as fully utilized + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - prefix + Provider: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: Full name of the provider + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + accounts: + type: array + items: + $ref: '#/components/schemas/NestedProviderAccount' + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + asns: + type: array + items: + $ref: '#/components/schemas/ASN' + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + circuit_count: + type: integer + format: int64 + readOnly: true + required: + - circuit_count + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + ProviderAccount: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + provider: + $ref: '#/components/schemas/BriefProvider' + name: + type: string + default: '' + maxLength: 100 + account: + type: string + title: Account ID + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - account + - created + - display + - display_url + - id + - last_updated + - provider + - url + ProviderAccountRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + name: + type: string + default: '' + maxLength: 100 + account: + type: string + minLength: 1 + title: Account ID + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - account + - provider + ProviderNetwork: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + provider: + $ref: '#/components/schemas/BriefProvider' + name: + type: string + maxLength: 100 + service_id: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - provider + - url + ProviderNetworkRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + name: + type: string + minLength: 1 + maxLength: 100 + service_id: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - provider + ProviderRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Full name of the provider + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + accounts: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + asns: + type: array + items: + type: integer + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + RIR: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + is_private: + type: boolean + title: Private + description: IP space managed by this RIR is considered private + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + aggregate_count: + type: integer + format: int64 + readOnly: true + required: + - aggregate_count + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + RIRRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + is_private: + type: boolean + title: Private + description: IP space managed by this RIR is considered private + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + Rack: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + facility_id: + type: string + nullable: true + maxLength: 50 + site: + $ref: '#/components/schemas/BriefSite' + location: + allOf: + - $ref: '#/components/schemas/BriefLocation' + nullable: true + group: + allOf: + - $ref: '#/components/schemas/BriefRackGroup' + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + status: + type: object + properties: + value: + enum: + - reserved + - available + - planned + - active + - deprecated + type: string + description: |- + * `reserved` - Reserved + * `available` - Available + * `planned` - Planned + * `active` - Active + * `deprecated` - Deprecated + x-spec-enum-id: 76eea4eef8804bcb + label: + type: string + enum: + - Reserved + - Available + - Planned + - Active + - Deprecated + role: + allOf: + - $ref: '#/components/schemas/BriefRackRole' + nullable: true + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this rack + maxLength: 50 + rack_type: + allOf: + - $ref: '#/components/schemas/BriefRackType' + nullable: true + form_factor: + type: object + properties: + value: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + - '' + - null + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + label: + type: string + enum: + - 2-post frame + - 4-post frame + - 4-post cabinet + - Wall-mounted frame + - Wall-mounted frame (vertical) + - Wall-mounted cabinet + - Wall-mounted cabinet (vertical) + nullable: true + width: + type: object + properties: + value: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + description: |- + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + x-spec-enum-id: 9b322795f297a9c3 + label: + type: string + enum: + - 10 inches + - 19 inches + - 21 inches + - 23 inches + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + type: object + properties: + value: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + label: + type: string + enum: + - Kilograms + - Grams + - Pounds + - Ounces + nullable: true + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + type: object + properties: + value: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + label: + type: string + enum: + - Millimeters + - Inches + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + airflow: + type: object + properties: + value: + enum: + - front-to-rear + - rear-to-front + - '' + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + x-spec-enum-id: a784734d07ef1b3c + label: + type: string + enum: + - Front to rear + - Rear to front + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + device_count: + type: integer + format: int64 + readOnly: true + powerfeed_count: + type: integer + format: int64 + readOnly: true + required: + - created + - device_count + - display + - display_url + - id + - last_updated + - name + - powerfeed_count + - site + - url + RackGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + rack_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - rack_count + - slug + - url + RackGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + RackRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + facility_id: + type: string + nullable: true + maxLength: 50 + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackGroupRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - reserved + - available + - planned + - active + - deprecated + type: string + description: |- + * `reserved` - Reserved + * `available` - Available + * `planned` - Planned + * `active` - Active + * `deprecated` - Deprecated + x-spec-enum-id: 76eea4eef8804bcb + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRoleRequest' + nullable: true + nullable: true + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this rack + maxLength: 50 + rack_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackTypeRequest' + nullable: true + nullable: true + form_factor: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + - '' + - null + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + nullable: true + width: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + description: |- + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + x-spec-enum-id: 9b322795f297a9c3 + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + airflow: + enum: + - front-to-rear + - rear-to-front + - '' + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + x-spec-enum-id: a784734d07ef1b3c + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - site + RackReservation: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + rack: + $ref: '#/components/schemas/BriefRack' + units: + type: array + items: + type: integer + maximum: 32767 + minimum: 0 + unit_count: + type: integer + format: int32 + readOnly: true + status: + type: object + properties: + value: + enum: + - pending + - active + - stale + type: string + description: |- + * `pending` - Pending + * `active` - Active + * `stale` - Stale + x-spec-enum-id: ed6038a4deee151c + label: + type: string + enum: + - Pending + - Active + - Stale + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + user: + $ref: '#/components/schemas/BriefUser' + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + required: + - created + - description + - display + - display_url + - id + - last_updated + - rack + - unit_count + - units + - url + - user + RackReservationRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + rack: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRackRequest' + units: + type: array + items: + type: integer + maximum: 32767 + minimum: 0 + status: + enum: + - pending + - active + - stale + type: string + description: |- + * `pending` - Pending + * `active` - Active + * `stale` - Stale + x-spec-enum-id: ed6038a4deee151c + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + minLength: 1 + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - description + - rack + - units + - user + RackRole: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + rack_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - rack_count + - slug + - url + RackRoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + RackType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + manufacturer: + $ref: '#/components/schemas/BriefManufacturer' + model: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + form_factor: + type: object + properties: + value: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + - '' + - null + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + label: + type: string + enum: + - 2-post frame + - 4-post frame + - 4-post cabinet + - Wall-mounted frame + - Wall-mounted frame (vertical) + - Wall-mounted cabinet + - Wall-mounted cabinet (vertical) + nullable: true + width: + type: object + properties: + value: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + description: |- + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + x-spec-enum-id: 9b322795f297a9c3 + label: + type: string + enum: + - 10 inches + - 19 inches + - 21 inches + - 23 inches + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + type: object + properties: + value: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + label: + type: string + enum: + - Millimeters + - Inches + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + type: object + properties: + value: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + label: + type: string + enum: + - Kilograms + - Grams + - Pounds + - Ounces + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + rack_count: + type: integer + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - manufacturer + - model + - rack_count + - slug + - url + RackTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + form_factor: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + - '' + - null + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + nullable: true + width: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + description: |- + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + x-spec-enum-id: 9b322795f297a9c3 + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - manufacturer + - model + - slug + RackUnit: + type: object + description: A rack unit is an abstraction formed by the set (rack, position, + face); it does not exist as a row in the database. + properties: + id: + type: number + format: double + maximum: 1000 + minimum: -1000 + exclusiveMaximum: true + exclusiveMinimum: true + readOnly: true + name: + type: string + readOnly: true + face: + type: object + properties: + value: + enum: + - front + - rear + type: string + description: |- + * `front` - Front + * `rear` - Rear + x-spec-enum-id: d2fb9b3f75158b83 + label: + type: string + enum: + - Front + - Rear + readOnly: true + device: + allOf: + - $ref: '#/components/schemas/BriefDevice' + readOnly: true + occupied: + type: boolean + readOnly: true + display: + type: string + readOnly: true + required: + - device + - display + - face + - id + - name + - occupied + RearPort: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device: + $ref: '#/components/schemas/BriefDevice' + module: + allOf: + - $ref: '#/components/schemas/BriefModule' + nullable: true + name: + type: string + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + label: + type: string + enum: + - 8P8C + - 8P6C + - 8P4C + - 8P2C + - 6P6C + - 6P4C + - 6P2C + - 4P4C + - 4P2C + - GG45 + - TERA 4P + - TERA 2P + - TERA 1P + - 110 Punch + - BNC + - F Connector + - N Connector + - MRJ21 + - FC + - FC/PC + - FC/UPC + - FC/APC + - LC + - LC/PC + - LC/UPC + - LC/APC + - LSH + - LSH/PC + - LSH/UPC + - LSH/APC + - LX.5 + - LX.5/PC + - LX.5/UPC + - LX.5/APC + - MPO + - MTRJ + - SC + - SC/PC + - SC/UPC + - SC/APC + - ST + - CS + - SN + - SMA 905 + - SMA 906 + - URM-P2 + - URM-P4 + - URM-P8 + - Splice + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortMapping' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + cable: + allOf: + - $ref: '#/components/schemas/BriefCable' + readOnly: true + nullable: true + cable_end: + enum: + - A + - B + - null + type: string + description: |- + * `A` - A + * `B` - B + x-spec-enum-id: 1db84f9b93b261c8 + readOnly: true + nullable: true + link_peers: + type: array + items: {} + readOnly: true + link_peers_type: + type: string + description: Return the type of the peer link terminations, or None. + readOnly: true + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + _occupied: + type: boolean + readOnly: true + title: ' occupied' + required: + - _occupied + - cable + - cable_end + - created + - device + - display + - display_url + - id + - last_updated + - link_peers + - link_peers_type + - name + - type + - url + RearPortMapping: + type: object + properties: + position: + type: integer + front_port: + type: integer + front_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - front_port + - position + RearPortMappingRequest: + type: object + properties: + position: + type: integer + front_port: + type: integer + front_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - front_port + - position + RearPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortMappingRequest' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - type + RearPortTemplate: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + device_type: + allOf: + - $ref: '#/components/schemas/BriefDeviceType' + nullable: true + module_type: + allOf: + - $ref: '#/components/schemas/BriefModuleType' + nullable: true + name: + type: string + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + type: object + properties: + value: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + label: + type: string + enum: + - 8P8C + - 8P6C + - 8P4C + - 8P2C + - 6P6C + - 6P4C + - 6P2C + - 4P4C + - 4P2C + - GG45 + - TERA 4P + - TERA 2P + - TERA 1P + - 110 Punch + - BNC + - F Connector + - N Connector + - MRJ21 + - FC + - FC/PC + - FC/UPC + - FC/APC + - LC + - LC/PC + - LC/UPC + - LC/APC + - LSH + - LSH/PC + - LSH/UPC + - LSH/APC + - LX.5 + - LX.5/PC + - LX.5/UPC + - LX.5/APC + - MPO + - MTRJ + - SC + - SC/PC + - SC/UPC + - SC/APC + - ST + - CS + - SN + - SMA 905 + - SMA 906 + - URM-P2 + - URM-P4 + - URM-P8 + - Splice + - USB Type A + - USB Type B + - USB Type C + - USB Mini A + - USB Mini B + - USB Micro A + - USB Micro B + - USB Micro AB + - Other + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateMapping' + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - id + - last_updated + - name + - type + - url + RearPortTemplateMapping: + type: object + properties: + position: + type: integer + front_port: + type: integer + front_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - front_port + - position + RearPortTemplateMappingRequest: + type: object + properties: + position: + type: integer + front_port: + type: integer + front_port_position: + type: integer + maximum: 1024 + minimum: 1 + default: 1 + required: + - front_port + - position + RearPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateMappingRequest' + description: + type: string + maxLength: 200 + required: + - name + - type + Region: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedRegion' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + site_count: + type: integer + readOnly: true + default: 0 + prefix_count: + type: integer + format: int64 + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - created + - display + - display_url + - id + - last_updated + - name + - prefix_count + - site_count + - slug + - url + RegionRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedRegionRequest' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + Role: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + weight: + type: integer + maximum: 32767 + minimum: 0 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + prefix_count: + type: integer + format: int64 + readOnly: true + vlan_count: + type: integer + format: int64 + readOnly: true + asn_count: + type: integer + format: int64 + readOnly: true + required: + - asn_count + - created + - display + - display_url + - id + - last_updated + - name + - prefix_count + - slug + - url + - vlan_count + RoleRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + weight: + type: integer + maximum: 32767 + minimum: 0 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + RouteTarget: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: Route target value (formatted in accordance with RFC 4360) + maxLength: 21 + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - url + RouteTargetRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Route target value (formatted in accordance with RFC 4360) + maxLength: 21 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + SavedFilter: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_types: + type: array + items: + type: string + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + user: + type: integer + nullable: true + weight: + type: integer + maximum: 32767 + minimum: 0 + enabled: + type: boolean + shared: + type: boolean + parameters: {} + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - object_types + - parameters + - slug + - url + SavedFilterRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + user: + type: integer + nullable: true + weight: + type: integer + maximum: 32767 + minimum: 0 + enabled: + type: boolean + shared: + type: boolean + parameters: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + required: + - name + - object_types + - parameters + - slug + Script: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + module: + type: integer + readOnly: true + name: + type: string + readOnly: true + description: + type: string + nullable: true + readOnly: true + vars: + nullable: true + readOnly: true + result: + allOf: + - $ref: '#/components/schemas/BriefJob' + readOnly: true + display: + type: string + readOnly: true + is_executable: + type: boolean + readOnly: true + required: + - description + - display + - display_url + - id + - is_executable + - module + - name + - result + - url + - vars + ScriptInputRequest: + type: object + properties: + data: {} + commit: + type: boolean + schedule_at: + type: string + format: date-time + nullable: true + interval: + type: integer + nullable: true + notifications: + enum: + - always + - on_failure + - never + type: string + description: |- + * `always` - Always + * `on_failure` - On failure + * `never` - Never + x-spec-enum-id: 57071f4400340a5c + default: always + required: + - commit + - data + ScriptModule: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + display: + type: string + readOnly: true + file_path: + type: string + readOnly: true + created: + type: string + format: date-time + readOnly: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - file_path + - id + - last_updated + ScriptModuleRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + file: + type: string + format: binary + writeOnly: true + required: + - file + Service: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + parent_object_type: + type: string + parent_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + parent: + readOnly: true + nullable: true + name: + type: string + maxLength: 100 + protocol: + type: object + properties: + value: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + label: + type: string + enum: + - TCP + - UDP + - SCTP + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + ipaddresses: + type: array + items: + $ref: '#/components/schemas/IPAddress' + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - parent + - parent_object_id + - parent_object_type + - ports + - url + ServiceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + parent_object_type: + type: string + parent_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + name: + type: string + minLength: 1 + maxLength: 100 + protocol: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + ipaddresses: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - parent_object_id + - parent_object_type + - ports + ServiceTemplate: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + protocol: + type: object + properties: + value: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + label: + type: string + enum: + - TCP + - UDP + - SCTP + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - ports + - url + ServiceTemplateRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + protocol: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - ports + Site: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + description: Full name of the site + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + status: + type: object + properties: + value: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + label: + type: string + enum: + - Planned + - Staging + - Active + - Decommissioning + - Retired + region: + allOf: + - $ref: '#/components/schemas/BriefRegion' + nullable: true + group: + allOf: + - $ref: '#/components/schemas/BriefSiteGroup' + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + time_zone: + type: string + nullable: true + description: + type: string + maxLength: 200 + physical_address: + type: string + description: Physical location of the building + maxLength: 200 + shipping_address: + type: string + description: If different from the physical address + maxLength: 200 + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + asns: + type: array + items: + $ref: '#/components/schemas/ASN' + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + circuit_count: + type: integer + format: int64 + readOnly: true + device_count: + type: integer + format: int64 + readOnly: true + prefix_count: + type: integer + format: int64 + readOnly: true + rack_count: + type: integer + format: int64 + readOnly: true + virtualmachine_count: + type: integer + format: int64 + readOnly: true + vlan_count: + type: integer + format: int64 + readOnly: true + required: + - circuit_count + - created + - device_count + - display + - display_url + - id + - last_updated + - name + - prefix_count + - rack_count + - slug + - url + - virtualmachine_count + - vlan_count + SiteGroup: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedSiteGroup' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + site_count: + type: integer + readOnly: true + default: 0 + prefix_count: + type: integer + format: int64 + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - created + - display + - display_url + - id + - last_updated + - name + - prefix_count + - site_count + - slug + - url + SiteGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedSiteGroupRequest' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + SiteRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Full name of the site + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + status: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + region: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRegionRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteGroupRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + time_zone: + type: string + nullable: true + minLength: 1 + description: + type: string + maxLength: 200 + physical_address: + type: string + description: Physical location of the building + maxLength: 200 + shipping_address: + type: string + description: If different from the physical address + maxLength: 200 + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + asns: + type: array + items: + type: integer + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + Subscription: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + object: + readOnly: true + nullable: true + user: + $ref: '#/components/schemas/BriefUser' + created: + type: string + format: date-time + readOnly: true + required: + - created + - display + - id + - object + - object_id + - object_type + - url + - user + SubscriptionRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + required: + - object_id + - object_type + - user + TableConfig: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + table: + type: string + maxLength: 100 + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + user: + type: integer + nullable: true + weight: + type: integer + maximum: 32767 + minimum: 0 + enabled: + type: boolean + shared: + type: boolean + columns: + type: array + items: + type: string + maxLength: 100 + ordering: + type: array + items: + type: string + maxLength: 100 + nullable: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - columns + - created + - display + - display_url + - id + - last_updated + - name + - object_type + - table + - url + TableConfigRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + object_type: + type: string + table: + type: string + minLength: 1 + maxLength: 100 + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + user: + type: integer + nullable: true + weight: + type: integer + maximum: 32767 + minimum: 0 + enabled: + type: boolean + shared: + type: boolean + columns: + type: array + items: + type: string + minLength: 1 + maxLength: 100 + ordering: + type: array + items: + type: string + minLength: 1 + maxLength: 100 + nullable: true + required: + - columns + - name + - object_type + - table + Tag: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + pattern: ^[-\w]+$ + maxLength: 100 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + weight: + type: integer + maximum: 32767 + minimum: 0 + object_types: + type: array + items: + type: string + tagged_items: + type: integer + format: int64 + readOnly: true + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - slug + - tagged_items + - url + TagRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + pattern: ^[-\w]+$ + maxLength: 100 + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + weight: + type: integer + maximum: 32767 + minimum: 0 + object_types: + type: array + items: + type: string + required: + - name + - slug + TaggedItem: + type: object + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + object_type: + type: string + readOnly: true + object_id: + type: integer + maximum: 2147483647 + minimum: -2147483648 + object: + readOnly: true + tag: + allOf: + - $ref: '#/components/schemas/BriefTag' + readOnly: true + required: + - display + - id + - object + - object_id + - object_type + - tag + - url + Tenant: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + group: + allOf: + - $ref: '#/components/schemas/BriefTenantGroup' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + circuit_count: + type: integer + format: int64 + readOnly: true + device_count: + type: integer + format: int64 + readOnly: true + ipaddress_count: + type: integer + format: int64 + readOnly: true + prefix_count: + type: integer + format: int64 + readOnly: true + rack_count: + type: integer + format: int64 + readOnly: true + site_count: + type: integer + format: int64 + readOnly: true + virtualmachine_count: + type: integer + format: int64 + readOnly: true + vlan_count: + type: integer + format: int64 + readOnly: true + vrf_count: + type: integer + format: int64 + readOnly: true + cluster_count: + type: integer + format: int64 + readOnly: true + required: + - circuit_count + - cluster_count + - created + - device_count + - display + - display_url + - id + - ipaddress_count + - last_updated + - name + - prefix_count + - rack_count + - site_count + - slug + - url + - virtualmachine_count + - vlan_count + - vrf_count + TenantGroup: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedTenantGroup' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + tenant_count: + type: integer + readOnly: true + default: 0 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - created + - display + - display_url + - id + - last_updated + - name + - slug + - tenant_count + - url + TenantGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedTenantGroupRequest' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + TenantRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantGroupRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + Token: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - v1 + * `2` - v2 + x-spec-enum-id: b5df70f0bffd12cb + minimum: 0 + maximum: 32767 + key: + type: string + readOnly: true + nullable: true + description: v2 token identification key + user: + $ref: '#/components/schemas/BriefUser' + description: + type: string + maxLength: 200 + created: + type: string + format: date-time + readOnly: true + expires: + type: string + format: date-time + nullable: true + last_used: + type: string + format: date-time + nullable: true + enabled: + type: boolean + description: Disable to temporarily revoke this token without deleting it. + write_enabled: + type: boolean + description: Permit create/update/delete operations using this token + pepper_id: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: ID of the cryptographic pepper used to hash the token (v2 only) + token: + type: string + required: + - created + - display + - display_url + - id + - key + - url + - user + TokenProvision: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - v1 + * `2` - v2 + x-spec-enum-id: b5df70f0bffd12cb + minimum: 0 + maximum: 32767 + user: + allOf: + - $ref: '#/components/schemas/BriefUser' + readOnly: true + key: + type: string + readOnly: true + created: + type: string + format: date-time + readOnly: true + expires: + type: string + format: date-time + nullable: true + last_used: + type: string + format: date-time + readOnly: true + enabled: + type: boolean + description: Disable to temporarily revoke this token without deleting it. + write_enabled: + type: boolean + description: Permit create/update/delete operations using this token + description: + type: string + maxLength: 200 + token: + type: string + required: + - created + - display + - display_url + - id + - key + - last_used + - url + - user + TokenProvisionRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - v1 + * `2` - v2 + x-spec-enum-id: b5df70f0bffd12cb + minimum: 0 + maximum: 32767 + expires: + type: string + format: date-time + nullable: true + enabled: + type: boolean + description: Disable to temporarily revoke this token without deleting it. + write_enabled: + type: boolean + description: Permit create/update/delete operations using this token + description: + type: string + maxLength: 200 + username: + type: string + writeOnly: true + minLength: 1 + password: + type: string + writeOnly: true + minLength: 1 + token: + type: string + minLength: 1 + required: + - password + - username + TokenRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - v1 + * `2` - v2 + x-spec-enum-id: b5df70f0bffd12cb + minimum: 0 + maximum: 32767 + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + description: + type: string + maxLength: 200 + expires: + type: string + format: date-time + nullable: true + last_used: + type: string + format: date-time + nullable: true + enabled: + type: boolean + description: Disable to temporarily revoke this token without deleting it. + write_enabled: + type: boolean + description: Permit create/update/delete operations using this token + pepper_id: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: ID of the cryptographic pepper used to hash the token (v2 only) + token: + type: string + minLength: 1 + required: + - user + Tunnel: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + status: + type: object + properties: + value: + enum: + - planned + - active + - disabled + type: string + description: |- + * `planned` - Planned + * `active` - Active + * `disabled` - Disabled + x-spec-enum-id: 2431ef62c418f485 + label: + type: string + enum: + - Planned + - Active + - Disabled + group: + allOf: + - $ref: '#/components/schemas/BriefTunnelGroup' + nullable: true + encapsulation: + type: object + properties: + value: + enum: + - ipsec-transport + - ipsec-tunnel + - ip-ip + - gre + - wireguard + - openvpn + - l2tp + - pptp + type: string + description: |- + * `ipsec-transport` - IPsec - Transport + * `ipsec-tunnel` - IPsec - Tunnel + * `ip-ip` - IP-in-IP + * `gre` - GRE + * `wireguard` - WireGuard + * `openvpn` - OpenVPN + * `l2tp` - L2TP + * `pptp` - PPTP + x-spec-enum-id: 4f3254459f0e94f0 + label: + type: string + enum: + - IPsec - Transport + - IPsec - Tunnel + - IP-in-IP + - GRE + - WireGuard + - OpenVPN + - L2TP + - PPTP + ipsec_profile: + allOf: + - $ref: '#/components/schemas/BriefIPSecProfile' + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + tunnel_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + terminations_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - encapsulation + - id + - last_updated + - name + - status + - terminations_count + - url + TunnelGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + tunnel_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - slug + - tunnel_count + - url + TunnelGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + TunnelRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + status: + enum: + - planned + - active + - disabled + type: string + description: |- + * `planned` - Planned + * `active` - Active + * `disabled` - Disabled + x-spec-enum-id: 2431ef62c418f485 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTunnelGroupRequest' + nullable: true + nullable: true + encapsulation: + enum: + - ipsec-transport + - ipsec-tunnel + - ip-ip + - gre + - wireguard + - openvpn + - l2tp + - pptp + type: string + description: |- + * `ipsec-transport` - IPsec - Transport + * `ipsec-tunnel` - IPsec - Tunnel + * `ip-ip` - IP-in-IP + * `gre` - GRE + * `wireguard` - WireGuard + * `openvpn` - OpenVPN + * `l2tp` - L2TP + * `pptp` - PPTP + x-spec-enum-id: 4f3254459f0e94f0 + ipsec_profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPSecProfileRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + tunnel_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - encapsulation + - name + - status + TunnelTermination: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + tunnel: + $ref: '#/components/schemas/BriefTunnel' + role: + type: object + properties: + value: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + label: + type: string + enum: + - Peer + - Hub + - Spoke + termination_type: + type: string + termination_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + termination: + readOnly: true + nullable: true + outside_ip: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - role + - termination + - termination_type + - tunnel + - url + TunnelTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + tunnel: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefTunnelRequest' + role: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + termination_type: + type: string + termination_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + outside_ip: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - role + - termination_type + - tunnel + User: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + username: + type: string + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + pattern: ^[\w.@+-]+$ + maxLength: 150 + first_name: + type: string + maxLength: 150 + last_name: + type: string + maxLength: 150 + email: + type: string + format: email + title: Email address + maxLength: 254 + is_active: + type: boolean + title: Active + description: Designates whether this user should be treated as active. Unselect + this instead of deleting accounts. + date_joined: + type: string + format: date-time + last_login: + type: string + format: date-time + nullable: true + groups: + type: array + items: + $ref: '#/components/schemas/Group' + permissions: + type: array + items: + $ref: '#/components/schemas/ObjectPermission' + required: + - display + - display_url + - id + - url + - username + UserRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + username: + type: string + minLength: 1 + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + pattern: ^[\w.@+-]+$ + maxLength: 150 + password: + type: string + writeOnly: true + minLength: 1 + maxLength: 128 + first_name: + type: string + maxLength: 150 + last_name: + type: string + maxLength: 150 + email: + type: string + format: email + title: Email address + maxLength: 254 + is_active: + type: boolean + title: Active + description: Designates whether this user should be treated as active. Unselect + this instead of deleting accounts. + date_joined: + type: string + format: date-time + last_login: + type: string + format: date-time + nullable: true + groups: + type: array + items: + type: integer + permissions: + type: array + items: + type: integer + required: + - password + - username + VLAN: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + site: + allOf: + - $ref: '#/components/schemas/BriefSite' + nullable: true + group: + allOf: + - $ref: '#/components/schemas/BriefVLANGroup' + nullable: true + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + maxLength: 64 + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + status: + type: object + properties: + value: + enum: + - active + - reserved + - deprecated + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + x-spec-enum-id: ca933c38b935e547 + label: + type: string + enum: + - Active + - Reserved + - Deprecated + role: + allOf: + - $ref: '#/components/schemas/BriefRole' + nullable: true + description: + type: string + maxLength: 200 + qinq_role: + type: object + properties: + value: + enum: + - svlan + - cvlan + - null + type: string + description: |- + * `svlan` - Service + * `cvlan` - Customer + x-spec-enum-id: fa0abd59fb1a7312 + label: + type: string + enum: + - Service + - Customer + nullable: true + qinq_svlan: + allOf: + - $ref: '#/components/schemas/NestedVLAN' + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + l2vpn_termination: + allOf: + - $ref: '#/components/schemas/BriefL2VPNTermination' + readOnly: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + prefix_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - id + - l2vpn_termination + - last_updated + - name + - prefix_count + - url + - vid + VLANGroup: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + scope: + readOnly: true + nullable: true + vid_ranges: + type: array + items: + $ref: '#/components/schemas/IntegerRange' + total_vlan_ids: + type: integer + readOnly: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + vlan_count: + type: integer + format: int64 + readOnly: true + utilization: + type: string + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - scope + - slug + - total_vlan_ids + - url + - utilization + - vlan_count + VLANGroupRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + vid_ranges: + type: array + items: + $ref: '#/components/schemas/IntegerRangeRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + VLANRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + site: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANGroupRequest' + nullable: true + nullable: true + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + minLength: 1 + maxLength: 64 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + x-spec-enum-id: ca933c38b935e547 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + qinq_role: + enum: + - svlan + - cvlan + - null + type: string + description: |- + * `svlan` - Service + * `cvlan` - Customer + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + qinq_svlan: + allOf: + - $ref: '#/components/schemas/NestedVLANRequest' + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - vid + VLANTranslationPolicy: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + description: + type: string + maxLength: 200 + rules: + type: array + items: + $ref: '#/components/schemas/VLANTranslationRule' + readOnly: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + required: + - display + - id + - name + - rules + - url + VLANTranslationPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + VLANTranslationRule: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + policy: + type: integer + local_vid: + type: integer + maximum: 4094 + minimum: 1 + title: Local VLAN ID + description: Numeric VLAN ID (1-4094) + remote_vid: + type: integer + maximum: 4094 + minimum: 1 + title: Remote VLAN ID + description: Numeric VLAN ID (1-4094) + description: + type: string + maxLength: 200 + required: + - display + - id + - local_vid + - policy + - remote_vid + - url + VLANTranslationRuleRequest: + type: object + description: Adds support for custom fields and tags. + properties: + policy: + type: integer + local_vid: + type: integer + maximum: 4094 + minimum: 1 + title: Local VLAN ID + description: Numeric VLAN ID (1-4094) + remote_vid: + type: integer + maximum: 4094 + minimum: 1 + title: Remote VLAN ID + description: Numeric VLAN ID (1-4094) + description: + type: string + maxLength: 200 + required: + - local_vid + - policy + - remote_vid + VMInterface: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + virtual_machine: + $ref: '#/components/schemas/BriefVirtualMachine' + name: + type: string + maxLength: 64 + enabled: + type: boolean + parent: + allOf: + - $ref: '#/components/schemas/NestedVMInterface' + nullable: true + bridge: + allOf: + - $ref: '#/components/schemas/NestedVMInterface' + nullable: true + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + mac_address: + type: string + readOnly: true + nullable: true + primary_mac_address: + allOf: + - $ref: '#/components/schemas/BriefMACAddress' + nullable: true + mac_addresses: + type: array + items: + $ref: '#/components/schemas/BriefMACAddress' + readOnly: true + nullable: true + description: + type: string + maxLength: 200 + mode: + type: object + properties: + value: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + type: string + description: |- + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + x-spec-enum-id: 84129b71b974ebe5 + label: + type: string + enum: + - Access + - Tagged + - Tagged (All) + - Q-in-Q (802.1ad) + untagged_vlan: + allOf: + - $ref: '#/components/schemas/BriefVLAN' + nullable: true + tagged_vlans: + type: array + items: + $ref: '#/components/schemas/VLAN' + qinq_svlan: + allOf: + - $ref: '#/components/schemas/BriefVLAN' + nullable: true + vlan_translation_policy: + allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicy' + nullable: true + vrf: + allOf: + - $ref: '#/components/schemas/BriefVRF' + nullable: true + l2vpn_termination: + allOf: + - $ref: '#/components/schemas/BriefL2VPNTermination' + readOnly: true + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + count_ipaddresses: + type: integer + readOnly: true + count_fhrp_groups: + type: integer + readOnly: true + required: + - count_fhrp_groups + - count_ipaddresses + - created + - display + - display_url + - id + - l2vpn_termination + - last_updated + - mac_address + - mac_addresses + - name + - url + - virtual_machine + VMInterfaceRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + virtual_machine: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualMachineRequest' + name: + type: string + minLength: 1 + maxLength: 64 + enabled: + type: boolean + parent: + allOf: + - $ref: '#/components/schemas/NestedVMInterfaceRequest' + nullable: true + bridge: + allOf: + - $ref: '#/components/schemas/NestedVMInterfaceRequest' + nullable: true + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + primary_mac_address: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefMACAddressRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + mode: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + type: string + description: |- + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + x-spec-enum-id: 84129b71b974ebe5 + untagged_vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + tagged_vlans: + type: array + items: + type: integer + qinq_svlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + vlan_translation_policy: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' + nullable: true + nullable: true + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - virtual_machine + VRF: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + rd: + type: string + nullable: true + title: Route distinguisher + description: Unique route distinguisher (as defined in RFC 4364) + maxLength: 21 + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + enforce_unique: + type: boolean + title: Enforce unique space + description: Prevent duplicate prefixes/IP addresses within this VRF + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + import_targets: + type: array + items: + $ref: '#/components/schemas/RouteTarget' + export_targets: + type: array + items: + $ref: '#/components/schemas/RouteTarget' + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + ipaddress_count: + type: integer + format: int64 + readOnly: true + prefix_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - id + - ipaddress_count + - last_updated + - name + - prefix_count + - url + VRFRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + rd: + type: string + nullable: true + title: Route distinguisher + description: Unique route distinguisher (as defined in RFC 4364) + maxLength: 21 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + enforce_unique: + type: boolean + title: Enforce unique space + description: Prevent duplicate prefixes/IP addresses within this VRF + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + import_targets: + type: array + items: + type: integer + export_targets: + type: array + items: + type: integer + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + VirtualChassis: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 64 + domain: + type: string + maxLength: 30 + master: + allOf: + - $ref: '#/components/schemas/NestedDevice' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + member_count: + type: integer + readOnly: true + members: + type: array + items: + $ref: '#/components/schemas/NestedDevice' + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - member_count + - members + - name + - url + VirtualChassisRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + domain: + type: string + maxLength: 30 + master: + allOf: + - $ref: '#/components/schemas/NestedDeviceRequest' + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + VirtualCircuit: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + cid: + type: string + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider_network: + $ref: '#/components/schemas/BriefProviderNetwork' + provider_account: + allOf: + - $ref: '#/components/schemas/BriefProviderAccount' + nullable: true + type: + $ref: '#/components/schemas/BriefVirtualCircuitType' + status: + type: object + properties: + value: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + label: + type: string + enum: + - Planned + - Provisioning + - Active + - Offline + - Deprovisioning + - Decommissioned + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - cid + - created + - display + - display_url + - id + - last_updated + - provider_network + - type + - url + VirtualCircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider_network: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderNetworkRequest' + provider_account: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefProviderAccountRequest' + nullable: true + nullable: true + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualCircuitTypeRequest' + status: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - cid + - provider_network + - type + VirtualCircuitTermination: + type: object + description: Adds support for custom fields and tags. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + virtual_circuit: + $ref: '#/components/schemas/BriefVirtualCircuit' + role: + type: object + properties: + value: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + label: + type: string + enum: + - Peer + - Hub + - Spoke + interface: + $ref: '#/components/schemas/BriefInterface' + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - interface + - last_updated + - url + - virtual_circuit + VirtualCircuitTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + virtual_circuit: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualCircuitRequest' + role: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + interface: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - interface + - virtual_circuit + VirtualCircuitType: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + virtual_circuit_count: + type: integer + format: int64 + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + - virtual_circuit_count + VirtualCircuitTypeRequest: + type: object + description: Base serializer class for models inheriting from OrganizationalModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + VirtualDeviceContext: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 64 + device: + $ref: '#/components/schemas/BriefDevice' + identifier: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + primary_ip: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + readOnly: true + nullable: true + primary_ip4: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + primary_ip6: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + status: + type: object + properties: + value: + enum: + - active + - planned + - offline + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `offline` - Offline + x-spec-enum-id: 0e2c0919d51b83cb + label: + type: string + enum: + - Active + - Planned + - Offline + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + interface_count: + type: integer + format: int64 + readOnly: true + required: + - created + - device + - display + - display_url + - id + - interface_count + - last_updated + - name + - primary_ip + - status + - url + VirtualDeviceContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + identifier: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + status: + enum: + - active + - planned + - offline + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `offline` - Offline + x-spec-enum-id: 0e2c0919d51b83cb + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - status + VirtualDisk: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + virtual_machine: + $ref: '#/components/schemas/BriefVirtualMachine' + name: + type: string + maxLength: 64 + description: + type: string + maxLength: 200 + size: + type: integer + maximum: 2147483647 + minimum: 0 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - size + - url + - virtual_machine + VirtualDiskRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + virtual_machine: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualMachineRequest' + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + maxLength: 200 + size: + type: integer + maximum: 2147483647 + minimum: 0 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - size + - virtual_machine + VirtualMachineType: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + default_platform: + allOf: + - $ref: '#/components/schemas/BriefPlatform' + nullable: true + default_vcpus: + type: number + format: double + maximum: 10000 + minimum: 0.01 + exclusiveMaximum: true + nullable: true + default_memory: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Default memory (MB) + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + virtual_machine_count: + type: integer + readOnly: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + - virtual_machine_count + VirtualMachineTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + default_platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + default_vcpus: + type: number + format: double + maximum: 10000 + minimum: 0.01 + exclusiveMaximum: true + nullable: true + default_memory: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Default memory (MB) + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + VirtualMachineWithConfigContext: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 64 + virtual_machine_type: + allOf: + - $ref: '#/components/schemas/BriefVirtualMachineType' + nullable: true + role: + allOf: + - $ref: '#/components/schemas/BriefDeviceRole' + nullable: true + status: + type: object + properties: + value: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + - paused + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + * `paused` - Paused + x-spec-enum-id: effecc3b94e0b74b + label: + type: string + enum: + - Offline + - Active + - Planned + - Staged + - Failed + - Decommissioning + - Paused + start_on_boot: + type: object + properties: + value: + enum: + - 'on' + - 'off' + - laststate + type: string + description: |- + * `on` - On + * `off` - Off + * `laststate` - Last State + x-spec-enum-id: 610e33fc2fde73d6 + label: + type: string + enum: + - 'On' + - 'Off' + - Last State + site: + allOf: + - $ref: '#/components/schemas/BriefSite' + nullable: true + cluster: + allOf: + - $ref: '#/components/schemas/BriefCluster' + nullable: true + device: + allOf: + - $ref: '#/components/schemas/BriefDevice' + nullable: true + platform: + allOf: + - $ref: '#/components/schemas/BriefPlatform' + nullable: true + primary_ip: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + readOnly: true + nullable: true + primary_ip4: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + primary_ip6: + allOf: + - $ref: '#/components/schemas/BriefIPAddress' + nullable: true + vcpus: + type: number + format: double + maximum: 10000 + minimum: 0.01000000000000000020816681711721685132943093776702880859375 + exclusiveMaximum: true + nullable: true + memory: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + disk: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: + type: string + maxLength: 200 + serial: + type: string + title: Serial number + maxLength: 50 + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + config_template: + allOf: + - $ref: '#/components/schemas/BriefConfigTemplate' + nullable: true + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + interface_count: + type: integer + readOnly: true + virtual_disk_count: + type: integer + readOnly: true + config_context: + nullable: true + readOnly: true + required: + - config_context + - created + - display + - display_url + - id + - interface_count + - last_updated + - name + - primary_ip + - url + - virtual_disk_count + VirtualMachineWithConfigContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + virtual_machine_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVirtualMachineTypeRequest' + nullable: true + nullable: true + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRoleRequest' + nullable: true + nullable: true + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + - paused + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + * `paused` - Paused + x-spec-enum-id: effecc3b94e0b74b + start_on_boot: + enum: + - 'on' + - 'off' + - laststate + type: string + description: |- + * `on` - On + * `off` - Off + * `laststate` - Last State + x-spec-enum-id: 610e33fc2fde73d6 + site: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteRequest' + nullable: true + nullable: true + cluster: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterRequest' + nullable: true + nullable: true + device: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRequest' + nullable: true + nullable: true + platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + vcpus: + type: number + format: double + maximum: 10000 + minimum: 0.01000000000000000020816681711721685132943093776702880859375 + exclusiveMaximum: true + nullable: true + memory: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + disk: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: + type: string + maxLength: 200 + serial: + type: string + title: Serial number + maxLength: 50 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + custom_fields: + type: object + additionalProperties: {} + required: + - name + Webhook: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 150 + description: + type: string + maxLength: 200 + payload_url: + type: string + title: URL + description: This URL will be called using the HTTP method defined when + the webhook is called. Jinja2 template processing is supported with the + same context as the request body. + maxLength: 500 + http_method: + enum: + - GET + - POST + - PUT + - PATCH + - DELETE + type: string + description: |- + * `GET` - GET + * `POST` - POST + * `PUT` - PUT + * `PATCH` - PATCH + * `DELETE` - DELETE + x-spec-enum-id: 867bf764d3b1eeaa + http_content_type: + type: string + description: The complete list of official content types is available here. + maxLength: 100 + additional_headers: + type: string + description: 'User-supplied HTTP headers to be sent with the request in + addition to the HTTP content type. Headers should be defined in the format + Name: Value. Jinja2 template processing is supported with + the same context as the request body (below).' + body_template: + type: string + description: 'Jinja2 template for a custom request body. If blank, a JSON + object representing the change will be included. Available context data + includes: event, model, timestamp, + username, request_id, and data.' + secret: + type: string + description: When provided, the request will include a X-Hook-Signature + header containing a HMAC hex digest of the payload body using the secret + as the key. The secret is not transmitted in the request. + maxLength: 255 + ssl_verification: + type: boolean + description: Enable SSL certificate verification. Disable with caution! + ca_file_path: + type: string + nullable: true + description: The specific CA certificate file to use for SSL verification. + Leave blank to use the system defaults. + maxLength: 4096 + custom_fields: + type: object + additionalProperties: {} + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - name + - payload_url + - url + WebhookRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 150 + description: + type: string + maxLength: 200 + payload_url: + type: string + minLength: 1 + title: URL + description: This URL will be called using the HTTP method defined when + the webhook is called. Jinja2 template processing is supported with the + same context as the request body. + maxLength: 500 + http_method: + enum: + - GET + - POST + - PUT + - PATCH + - DELETE + type: string + description: |- + * `GET` - GET + * `POST` - POST + * `PUT` - PUT + * `PATCH` - PATCH + * `DELETE` - DELETE + x-spec-enum-id: 867bf764d3b1eeaa + http_content_type: + type: string + minLength: 1 + description: The complete list of official content types is available here. + maxLength: 100 + additional_headers: + type: string + description: 'User-supplied HTTP headers to be sent with the request in + addition to the HTTP content type. Headers should be defined in the format + Name: Value. Jinja2 template processing is supported with + the same context as the request body (below).' + body_template: + type: string + description: 'Jinja2 template for a custom request body. If blank, a JSON + object representing the change will be included. Available context data + includes: event, model, timestamp, + username, request_id, and data.' + secret: + type: string + description: When provided, the request will include a X-Hook-Signature + header containing a HMAC hex digest of the payload body using the secret + as the key. The secret is not transmitted in the request. + maxLength: 255 + ssl_verification: + type: boolean + description: Enable SSL certificate verification. Disable with caution! + ca_file_path: + type: string + nullable: true + description: The specific CA certificate file to use for SSL verification. + Leave blank to use the system defaults. + maxLength: 4096 + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + required: + - name + - payload_url + WirelessLAN: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + ssid: + type: string + maxLength: 32 + description: + type: string + maxLength: 200 + group: + allOf: + - $ref: '#/components/schemas/BriefWirelessLANGroup' + nullable: true + status: + type: object + properties: + value: + enum: + - active + - reserved + - disabled + - deprecated + - '' + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `disabled` - Disabled + * `deprecated` - Deprecated + x-spec-enum-id: e5549d7370ce2e6c + label: + type: string + enum: + - Active + - Reserved + - Disabled + - Deprecated + vlan: + allOf: + - $ref: '#/components/schemas/BriefVLAN' + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + scope: + readOnly: true + nullable: true + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + auth_type: + type: object + properties: + value: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + label: + type: string + enum: + - Open + - WEP + - WPA Personal (PSK) + - WPA Enterprise + auth_cipher: + type: object + properties: + value: + enum: + - auto + - tkip + - aes + - '' + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + label: + type: string + enum: + - Auto + - TKIP + - AES + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - last_updated + - scope + - ssid + - url + WirelessLANGroup: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + name: + type: string + maxLength: 100 + slug: + type: string + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedWirelessLANGroup' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + wirelesslan_count: + type: integer + readOnly: true + default: 0 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + _depth: + type: integer + readOnly: true + title: ' depth' + required: + - _depth + - created + - display + - display_url + - id + - last_updated + - name + - slug + - url + - wirelesslan_count + WirelessLANGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + allOf: + - $ref: '#/components/schemas/NestedWirelessLANGroupRequest' + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + WirelessLANRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + ssid: + type: string + minLength: 1 + maxLength: 32 + description: + type: string + maxLength: 200 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefWirelessLANGroupRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - disabled + - deprecated + - '' + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `disabled` - Disabled + * `deprecated` - Deprecated + x-spec-enum-id: e5549d7370ce2e6c + vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + auth_type: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + auth_cipher: + enum: + - auto + - tkip + - aes + - '' + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - ssid + WirelessLink: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + id: + type: integer + readOnly: true + url: + type: string + format: uri + readOnly: true + display_url: + type: string + format: uri + readOnly: true + display: + type: string + readOnly: true + interface_a: + $ref: '#/components/schemas/BriefInterface' + interface_b: + $ref: '#/components/schemas/BriefInterface' + ssid: + type: string + maxLength: 32 + status: + type: object + properties: + value: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + label: + type: string + enum: + - Connected + - Planned + - Decommissioning + tenant: + allOf: + - $ref: '#/components/schemas/BriefTenant' + nullable: true + auth_type: + type: object + properties: + value: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + label: + type: string + enum: + - Open + - WEP + - WPA Personal (PSK) + - WPA Enterprise + auth_cipher: + type: object + properties: + value: + enum: + - auto + - tkip + - aes + - '' + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + label: + type: string + enum: + - Auto + - TKIP + - AES + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + type: object + properties: + value: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + label: + type: string + enum: + - Kilometers + - Meters + - Miles + - Feet + nullable: true + description: + type: string + maxLength: 200 + owner: + allOf: + - $ref: '#/components/schemas/BriefOwner' + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTag' + custom_fields: + type: object + additionalProperties: {} + created: + type: string + format: date-time + readOnly: true + nullable: true + last_updated: + type: string + format: date-time + readOnly: true + nullable: true + required: + - created + - display + - display_url + - id + - interface_a + - interface_b + - last_updated + - url + WirelessLinkRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + interface_a: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + interface_b: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + ssid: + type: string + maxLength: 32 + status: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + auth_type: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + auth_cipher: + enum: + - auto + - tkip + - aes + - '' + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - interface_a + - interface_b + WritableAggregateRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + prefix: + type: string + minLength: 1 + rir: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRIRRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + date_added: + type: string + format: date + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - prefix + - rir + WritableCableRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + type: + enum: + - cat3 + - cat5 + - cat5e + - cat6 + - cat6a + - cat7 + - cat7a + - cat8 + - mrj21-trunk + - dac-active + - dac-passive + - coaxial + - rg-6 + - rg-8 + - rg-11 + - rg-59 + - rg-62 + - rg-213 + - lmr-100 + - lmr-200 + - lmr-400 + - mmf + - mmf-om1 + - mmf-om2 + - mmf-om3 + - mmf-om4 + - mmf-om5 + - smf + - smf-os1 + - smf-os2 + - aoc + - power + - usb + - '' + - null + type: string + description: |- + * `cat3` - CAT3 + * `cat5` - CAT5 + * `cat5e` - CAT5e + * `cat6` - CAT6 + * `cat6a` - CAT6a + * `cat7` - CAT7 + * `cat7a` - CAT7a + * `cat8` - CAT8 + * `mrj21-trunk` - MRJ21 Trunk + * `dac-active` - Direct Attach Copper (Active) + * `dac-passive` - Direct Attach Copper (Passive) + * `coaxial` - Coaxial + * `rg-6` - RG-6 + * `rg-8` - RG-8 + * `rg-11` - RG-11 + * `rg-59` - RG-59 + * `rg-62` - RG-62 + * `rg-213` - RG-213 + * `lmr-100` - LMR-100 + * `lmr-200` - LMR-200 + * `lmr-400` - LMR-400 + * `mmf` - Multimode Fiber + * `mmf-om1` - Multimode Fiber (OM1) + * `mmf-om2` - Multimode Fiber (OM2) + * `mmf-om3` - Multimode Fiber (OM3) + * `mmf-om4` - Multimode Fiber (OM4) + * `mmf-om5` - Multimode Fiber (OM5) + * `smf` - Single-mode Fiber + * `smf-os1` - Single-mode Fiber (OS1) + * `smf-os2` - Single-mode Fiber (OS2) + * `aoc` - Active Optical Cabling (AOC) + * `power` - Power + * `usb` - USB + x-spec-enum-id: 3d4d8d7ae24f7be8 + nullable: true + a_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObjectRequest' + b_terminations: + type: array + items: + $ref: '#/components/schemas/GenericObjectRequest' + status: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + profile: + enum: + - single-1c1p + - single-1c2p + - single-1c4p + - single-1c6p + - single-1c8p + - single-1c12p + - single-1c16p + - trunk-2c1p + - trunk-2c2p + - trunk-2c4p + - trunk-2c4p-shuffle + - trunk-2c6p + - trunk-2c8p + - trunk-2c12p + - trunk-4c1p + - trunk-4c2p + - trunk-4c4p + - trunk-4c4p-shuffle + - trunk-4c6p + - trunk-4c8p + - trunk-8c4p + - breakout-1c2p-2c1p + - breakout-1c4p-4c1p + - breakout-1c6p-6c1p + - breakout-2c4p-8c1p-shuffle + - '' + type: string + description: |- + * `single-1c1p` - 1C1P + * `single-1c2p` - 1C2P + * `single-1c4p` - 1C4P + * `single-1c6p` - 1C6P + * `single-1c8p` - 1C8P + * `single-1c12p` - 1C12P + * `single-1c16p` - 1C16P + * `trunk-2c1p` - 2C1P trunk + * `trunk-2c2p` - 2C2P trunk + * `trunk-2c4p` - 2C4P trunk + * `trunk-2c4p-shuffle` - 2C4P trunk (shuffle) + * `trunk-2c6p` - 2C6P trunk + * `trunk-2c8p` - 2C8P trunk + * `trunk-2c12p` - 2C12P trunk + * `trunk-4c1p` - 4C1P trunk + * `trunk-4c2p` - 4C2P trunk + * `trunk-4c4p` - 4C4P trunk + * `trunk-4c4p-shuffle` - 4C4P trunk (shuffle) + * `trunk-4c6p` - 4C6P trunk + * `trunk-4c8p` - 4C8P trunk + * `trunk-8c4p` - 8C4P trunk + * `breakout-1c2p-2c1p` - 1C2P:2C1P breakout + * `breakout-1c4p-4c1p` - 1C4P:4C1P breakout + * `breakout-1c6p-6c1p` - 1C6P:6C1P breakout + * `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle) + x-spec-enum-id: f566e6df6572f5d0 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + bundle: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefCableBundleRequest' + nullable: true + nullable: true + label: + type: string + maxLength: 100 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + length: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + length_unit: + enum: + - km + - m + - cm + - mi + - ft + - in + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `cm` - Centimeters + * `mi` - Miles + * `ft` - Feet + * `in` - Inches + x-spec-enum-id: 6e7645525ba02462 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + WritableCircuitGroupAssignmentRequest: + type: object + description: Base serializer for group assignments under CircuitSerializer. + properties: + group: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitGroupRequest' + member_type: + type: string + member_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + priority: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + - null + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + required: + - group + - member_id + - member_type + WritableCircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderRequest' + provider_account: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefProviderAccountRequest' + nullable: true + nullable: true + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefCircuitTypeRequest' + status: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + install_date: + type: string + format: date + nullable: true + title: Installed + termination_date: + type: string + format: date + nullable: true + title: Terminates + commit_rate: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: Commit rate (Kbps) + description: Committed rate + description: + type: string + maxLength: 200 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + assignments: + type: array + items: + $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request' + required: + - cid + - provider + - type + WritableClusterRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefClusterTypeRequest' + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterGroupRequest' + nullable: true + nullable: true + status: + enum: + - planned + - staging + - active + - decommissioning + - offline + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `offline` - Offline + x-spec-enum-id: 65a25166053759eb + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - type + WritableConsolePortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: |- + Physical port type + + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + speed: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + minimum: 0 + maximum: 2147483647 + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + WritableConsolePortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: + type: string + maxLength: 200 + required: + - name + WritableConsoleServerPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: |- + Physical port type + + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + speed: + enum: + - 1200 + - 2400 + - 4800 + - 9600 + - 19200 + - 38400 + - 57600 + - 115200 + - null + type: integer + x-spec-enum-id: ab6d9635c131a378 + nullable: true + description: |- + Port speed in bits per second + + * `1200` - 1200 bps + * `2400` - 2400 bps + * `4800` - 4800 bps + * `9600` - 9600 bps + * `19200` - 19.2 kbps + * `38400` - 38.4 kbps + * `57600` - 57.6 kbps + * `115200` - 115.2 kbps + minimum: 0 + maximum: 2147483647 + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + WritableConsoleServerPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - de-9 + - db-25 + - rj-11 + - rj-12 + - rj-45 + - mini-din-8 + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + - '' + - null + type: string + description: |- + * `de-9` - DE-9 + * `db-25` - DB-25 + * `rj-11` - RJ-11 + * `rj-12` - RJ-12 + * `rj-45` - RJ-45 + * `mini-din-8` - Mini-DIN 8 + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 7b8d0e83a4bb5178 + nullable: true + description: + type: string + maxLength: 200 + required: + - name + WritableContactAssignmentRequest: + type: object + description: Adds support for custom fields and tags. + properties: + object_type: + type: string + object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + contact: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefContactRequest' + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefContactRoleRequest' + nullable: true + nullable: true + priority: + enum: + - primary + - secondary + - tertiary + - inactive + - '' + - null + type: string + description: |- + * `primary` - Primary + * `secondary` - Secondary + * `tertiary` - Tertiary + * `inactive` - Inactive + x-spec-enum-id: 0548fc537440bf9d + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - contact + - object_id + - object_type + WritableContactGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + WritableCustomFieldChoiceSetRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + base_choices: + enum: + - IATA + - ISO_3166 + - UN_LOCODE + - '' + - null + type: string + x-spec-enum-id: cf0efb5195f85007 + nullable: true + description: |- + Base set of predefined choices (optional) + + * `IATA` - IATA (Airport codes) + * `ISO_3166` - ISO 3166 (Country codes) + * `UN_LOCODE` - UN/LOCODE (Location codes) + extra_choices: + type: array + items: + type: array + items: {} + maxItems: 2 + minItems: 2 + choice_colors: + type: object + additionalProperties: + enum: + - blue + - indigo + - purple + - pink + - red + - orange + - yellow + - green + - teal + - cyan + - gray + - black + - white + type: string + description: |- + * `blue` - Blue + * `indigo` - Indigo + * `purple` - Purple + * `pink` - Pink + * `red` - Red + * `orange` - Orange + * `yellow` - Yellow + * `green` - Green + * `teal` - Teal + * `cyan` - Cyan + * `gray` - Gray + * `black` - Black + * `white` - White + x-spec-enum-id: de0a6a124020dfe0 + order_alphabetically: + type: boolean + description: Choices are automatically ordered alphabetically + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + required: + - extra_choices + - name + WritableCustomFieldRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + type: + enum: + - text + - longtext + - integer + - decimal + - boolean + - date + - datetime + - url + - json + - select + - multiselect + - object + - multiobject + type: string + x-spec-enum-id: 47c52a3d983e924c + description: |- + The type of data this custom field holds + + * `text` - Text + * `longtext` - Text (long) + * `integer` - Integer + * `decimal` - Decimal + * `boolean` - Boolean (true/false) + * `date` - Date + * `datetime` - Date & time + * `url` - URL + * `json` - JSON + * `select` - Selection + * `multiselect` - Multiple selection + * `object` - Object + * `multiobject` - Multiple objects + related_object_type: + type: string + nullable: true + name: + type: string + minLength: 1 + description: Internal field name + pattern: ^[a-z0-9_]+$ + maxLength: 50 + label: + type: string + description: Name of the field as displayed to users (if not provided, 'the + field's name will be used) + maxLength: 50 + group_name: + type: string + description: Custom fields within the same group will be displayed together + maxLength: 50 + description: + type: string + maxLength: 200 + required: + type: boolean + description: This field is required when creating new objects or editing + an existing object. + unique: + type: boolean + title: Must be unique + description: The value of this field must be unique for the assigned object + search_weight: + type: integer + maximum: 32767 + minimum: 0 + description: Weighting for search. Lower values are considered more important. + Fields with a search weight of zero will be ignored. + filter_logic: + enum: + - disabled + - loose + - exact + type: string + x-spec-enum-id: d168820c798ae45a + description: |- + Loose matches any instance of a given string; exact matches the entire field. + + * `disabled` - Disabled + * `loose` - Loose + * `exact` - Exact + ui_visible: + enum: + - always + - if-set + - hidden + type: string + x-spec-enum-id: f32800c399b927b6 + description: |- + Specifies whether the custom field is displayed in the UI + + * `always` - Always + * `if-set` - If set + * `hidden` - Hidden + ui_editable: + enum: + - 'yes' + - 'no' + - hidden + type: string + x-spec-enum-id: 336f52760e62022f + description: |- + Specifies whether the custom field value can be edited in the UI + + * `yes` - Yes + * `no` - No + * `hidden` - Hidden + is_cloneable: + type: boolean + description: Replicate this value when cloning objects + default: + nullable: true + description: Default value for the field (must be a JSON value). Encapsulate + strings with double quotes (e.g. "Foo"). + related_object_filter: + nullable: true + description: Filter the object selection choices using a query_params dict + (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo"). + weight: + type: integer + maximum: 32767 + minimum: 0 + title: Display weight + description: Fields with higher weights appear lower in a form. + validation_minimum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Minimum value + description: Minimum allowed value (for numeric fields) + validation_maximum: + type: number + format: double + maximum: 1000000000000 + minimum: -1000000000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Maximum value + description: Maximum allowed value (for numeric fields) + validation_regex: + type: string + description: Regular expression to enforce on text field values. Use ^ and + $ to force matching of entire string. For example, ^[A-Z]{3}$ + will limit values to exactly three uppercase letters. + maxLength: 500 + validation_schema: + nullable: true + description: A JSON schema definition for validating the custom field value + choice_set: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefCustomFieldChoiceSetRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - object_types + WritableDataSourceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + type: + type: string + minLength: 1 + maxLength: 50 + source_url: + type: string + minLength: 1 + title: URL + maxLength: 200 + enabled: + type: boolean + description: + type: string + maxLength: 200 + sync_interval: + enum: + - 1 + - 60 + - 720 + - 1440 + - 10080 + - 43200 + - null + type: integer + description: |- + * `1` - Minutely + * `60` - Hourly + * `720` - 12 hours + * `1440` - Daily + * `10080` - Weekly + * `43200` - 30 days + x-spec-enum-id: 2e9f2567ecd93fbe + nullable: true + minimum: 0 + maximum: 32767 + parameters: + nullable: true + ignore_rules: + type: string + description: Patterns (one per line) matching files or paths to ignore when + syncing + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + custom_fields: + type: object + additionalProperties: {} + required: + - name + - source_url + - type + WritableDeviceRoleRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + color: + type: string + minLength: 1 + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + vm_role: + type: boolean + description: Virtual machines may be assigned to this role + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + WritableDeviceTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + default_platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + u_height: + type: number + format: double + maximum: 1000 + minimum: 0 + exclusiveMaximum: true + default: 1.0 + title: Position (U) + exclude_from_utilization: + type: boolean + description: Devices of this type are excluded when calculating rack utilization. + is_full_depth: + type: boolean + description: Device consumes both front and rear rack faces. + subdevice_role: + enum: + - parent + - child + - '' + - null + type: string + x-spec-enum-id: 65a61d5e1deb4a24 + nullable: true + title: Parent/child status + description: |- + Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. + + * `parent` - Parent + * `child` - Child + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + front_image: + type: string + format: binary + nullable: true + rear_image: + type: string + format: binary + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - manufacturer + - model + - slug + WritableDeviceWithConfigContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + nullable: true + maxLength: 64 + device_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + role: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRoleRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + serial: + type: string + title: Serial number + description: Chassis serial number, assigned by the manufacturer + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + rack: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRequest' + nullable: true + nullable: true + position: + type: number + format: double + maximum: 1000 + minimum: 0.5 + exclusiveMaximum: true + nullable: true + title: Position (U) + face: + enum: + - front + - rear + - '' + - null + type: string + description: |- + * `front` - Front + * `rear` - Rear + x-spec-enum-id: d2fb9b3f75158b83 + nullable: true + title: Rack face + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + status: + enum: + - offline + - active + - planned + - staged + - failed + - inventory + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `inventory` - Inventory + * `decommissioning` - Decommissioning + x-spec-enum-id: 65feb4244cc9110c + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - rear-to-side + - bottom-to-top + - top-to-bottom + - passive + - mixed + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `rear-to-side` - Rear to side + * `bottom-to-top` - Bottom to top + * `top-to-bottom` - Top to bottom + * `passive` - Passive + * `mixed` - Mixed + x-spec-enum-id: 11cb3d363b41ba9e + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + oob_ip: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + cluster: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterRequest' + nullable: true + nullable: true + virtual_chassis: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVirtualChassisRequest' + nullable: true + nullable: true + vc_position: + type: integer + maximum: 255 + minimum: 0 + nullable: true + vc_priority: + type: integer + maximum: 255 + minimum: 0 + nullable: true + description: Virtual chassis master election priority + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device_type + - role + - site + WritableEventRuleRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + object_types: + type: array + items: + type: string + name: + type: string + minLength: 1 + maxLength: 150 + enabled: + type: boolean + event_types: + type: array + items: + enum: + - object_created + - object_updated + - object_deleted + - job_started + - job_completed + - job_failed + - job_errored + type: string + description: |- + * `object_created` - Object created + * `object_updated` - Object updated + * `object_deleted` - Object deleted + * `job_started` - Job started + * `job_completed` - Job completed + * `job_failed` - Job failed + * `job_errored` - Job errored + x-spec-enum-id: 01e557313a5c7bd2 + description: The types of event which will trigger this rule. + conditions: + nullable: true + description: A set of conditions which determine whether the event will + be generated. + action_type: + enum: + - webhook + - script + - notification + type: string + description: |- + * `webhook` - Webhook + * `script` - Script + * `notification` - Notification + x-spec-enum-id: 287901b937995956 + action_object_type: + type: string + action_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + required: + - action_object_type + - event_types + - name + - object_types + WritableFrontPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortMappingRequest' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - type + WritableFrontPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + rear_ports: + type: array + items: + $ref: '#/components/schemas/FrontPortTemplateMappingRequest' + description: + type: string + maxLength: 200 + required: + - name + - type + WritableIKEPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + version: + enum: + - 1 + - 2 + type: integer + description: |- + * `1` - IKEv1 + * `2` - IKEv2 + x-spec-enum-id: 00872b77916a1fde + minimum: 0 + maximum: 32767 + mode: + enum: + - aggressive + - main + - '' + - null + type: string + description: |- + * `aggressive` - Aggressive + * `main` - Main + x-spec-enum-id: 64c1be7bdb2548ca + nullable: true + proposals: + type: array + items: + type: integer + preshared_key: + type: string + title: Pre-shared key + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + WritableIKEProposalRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + authentication_method: + enum: + - preshared-keys + - certificates + - rsa-signatures + - dsa-signatures + type: string + description: |- + * `preshared-keys` - Pre-shared keys + * `certificates` - Certificates + * `rsa-signatures` - RSA signatures + * `dsa-signatures` - DSA signatures + x-spec-enum-id: a21158c52d0c455a + encryption_algorithm: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + authentication_algorithm: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + - '' + - null + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + group: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + type: integer + x-spec-enum-id: dbef43be795462a8 + description: |- + Diffie-Hellman group ID + + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + minimum: 0 + maximum: 32767 + sa_lifetime: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Security association lifetime (in seconds) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - authentication_method + - encryption_algorithm + - group + - name + WritableIPAddressRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + address: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + - dhcp + - slaac + type: string + x-spec-enum-id: c421c4c4a0fa7a2a + description: |- + The operational status of this IP + + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + * `dhcp` - DHCP + * `slaac` - SLAAC + role: + enum: + - loopback + - secondary + - anycast + - vip + - vrrp + - hsrp + - glbp + - carp + - '' + - null + type: string + x-spec-enum-id: 53dca4cddd7b344a + nullable: true + description: |- + The functional role of this IP + + * `loopback` - Loopback + * `secondary` - Secondary + * `anycast` - Anycast + * `vip` - VIP + * `vrrp` - VRRP + * `hsrp` - HSRP + * `glbp` - GLBP + * `carp` - CARP + assigned_object_type: + type: string + nullable: true + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + nat_inside: + type: integer + nullable: true + title: NAT (inside) + description: The IP for which this address is the "outside" IP + dns_name: + type: string + description: Hostname or FQDN (not case-sensitive) + pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ + maxLength: 255 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - address + WritableIPRangeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + start_address: + type: string + minLength: 1 + end_address: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + type: string + x-spec-enum-id: ca933c38b935e547 + description: |- + Operational status of this range + + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + mark_populated: + type: boolean + description: Prevent the creation of IP addresses within this range + mark_utilized: + type: boolean + description: Report space as fully utilized + required: + - end_address + - start_address + WritableIPSecPolicyRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + proposals: + type: array + items: + type: integer + pfs_group: + enum: + - 1 + - 2 + - 5 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + - 24 + - 25 + - 26 + - 27 + - 28 + - 29 + - 30 + - 31 + - 32 + - 33 + - 34 + - null + type: integer + x-spec-enum-id: dbef43be795462a8 + nullable: true + description: |- + Diffie-Hellman group for Perfect Forward Secrecy + + * `1` - Group 1 + * `2` - Group 2 + * `5` - Group 5 + * `14` - Group 14 + * `15` - Group 15 + * `16` - Group 16 + * `17` - Group 17 + * `18` - Group 18 + * `19` - Group 19 + * `20` - Group 20 + * `21` - Group 21 + * `22` - Group 22 + * `23` - Group 23 + * `24` - Group 24 + * `25` - Group 25 + * `26` - Group 26 + * `27` - Group 27 + * `28` - Group 28 + * `29` - Group 29 + * `30` - Group 30 + * `31` - Group 31 + * `32` - Group 32 + * `33` - Group 33 + * `34` - Group 34 + minimum: 0 + maximum: 32767 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + WritableIPSecProfileRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + mode: + enum: + - esp + - ah + type: string + description: |- + * `esp` - ESP + * `ah` - AH + x-spec-enum-id: 87ac6ada0da14ccf + ike_policy: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefIKEPolicyRequest' + ipsec_policy: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefIPSecPolicyRequest' + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - ike_policy + - ipsec_policy + - mode + - name + WritableIPSecProposalRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + description: + type: string + maxLength: 200 + encryption_algorithm: + enum: + - aes-128-cbc + - aes-128-gcm + - aes-192-cbc + - aes-192-gcm + - aes-256-cbc + - aes-256-gcm + - 3des-cbc + - des-cbc + - '' + - null + type: string + description: |- + * `aes-128-cbc` - 128-bit AES (CBC) + * `aes-128-gcm` - 128-bit AES (GCM) + * `aes-192-cbc` - 192-bit AES (CBC) + * `aes-192-gcm` - 192-bit AES (GCM) + * `aes-256-cbc` - 256-bit AES (CBC) + * `aes-256-gcm` - 256-bit AES (GCM) + * `3des-cbc` - 3DES + * `des-cbc` - DES + x-spec-enum-id: ae3dabd7b2b3cba2 + nullable: true + title: Encryption + authentication_algorithm: + enum: + - hmac-sha1 + - hmac-sha256 + - hmac-sha384 + - hmac-sha512 + - hmac-md5 + - '' + - null + type: string + description: |- + * `hmac-sha1` - SHA-1 HMAC + * `hmac-sha256` - SHA-256 HMAC + * `hmac-sha384` - SHA-384 HMAC + * `hmac-sha512` - SHA-512 HMAC + * `hmac-md5` - MD5 HMAC + x-spec-enum-id: 0a7ca69695b483a7 + nullable: true + title: Authentication + sa_lifetime_seconds: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (seconds) + description: Security association lifetime (seconds) + sa_lifetime_data: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + title: SA lifetime (KB) + description: Security association lifetime (in kilobytes) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + WritableInterfaceRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + vdcs: + type: array + items: + type: integer + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + enabled: + type: boolean + parent: + type: integer + nullable: true + title: Parent interface + bridge: + type: integer + nullable: true + title: Bridge interface + lag: + type: integer + nullable: true + title: Parent LAG + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + primary_mac_address: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefMACAddressRequest' + nullable: true + nullable: true + speed: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + title: Speed (Kbps) + duplex: + enum: + - half + - full + - auto + - '' + - null + type: string + description: |- + * `half` - Half + * `full` - Full + * `auto` - Auto + x-spec-enum-id: 368458a2b67c916b + nullable: true + wwn: + type: string + nullable: true + mgmt_only: + type: boolean + title: Management only + description: This interface is used only for out-of-band management + description: + type: string + maxLength: 200 + mode: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + - null + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: |- + IEEE 802.1Q tagging strategy + + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + rf_role: + enum: + - ap + - station + - '' + - null + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + rf_channel: + enum: + - 2.4g-1-2412-22 + - 2.4g-2-2417-22 + - 2.4g-3-2422-22 + - 2.4g-4-2427-22 + - 2.4g-5-2432-22 + - 2.4g-6-2437-22 + - 2.4g-7-2442-22 + - 2.4g-8-2447-22 + - 2.4g-9-2452-22 + - 2.4g-10-2457-22 + - 2.4g-11-2462-22 + - 2.4g-12-2467-22 + - 2.4g-13-2472-22 + - 5g-32-5160-20 + - 5g-34-5170-40 + - 5g-36-5180-20 + - 5g-38-5190-40 + - 5g-40-5200-20 + - 5g-42-5210-80 + - 5g-44-5220-20 + - 5g-46-5230-40 + - 5g-48-5240-20 + - 5g-50-5250-160 + - 5g-52-5260-20 + - 5g-54-5270-40 + - 5g-56-5280-20 + - 5g-58-5290-80 + - 5g-60-5300-20 + - 5g-62-5310-40 + - 5g-64-5320-20 + - 5g-100-5500-20 + - 5g-102-5510-40 + - 5g-104-5520-20 + - 5g-106-5530-80 + - 5g-108-5540-20 + - 5g-110-5550-40 + - 5g-112-5560-20 + - 5g-114-5570-160 + - 5g-116-5580-20 + - 5g-118-5590-40 + - 5g-120-5600-20 + - 5g-122-5610-80 + - 5g-124-5620-20 + - 5g-126-5630-40 + - 5g-128-5640-20 + - 5g-132-5660-20 + - 5g-134-5670-40 + - 5g-136-5680-20 + - 5g-138-5690-80 + - 5g-140-5700-20 + - 5g-142-5710-40 + - 5g-144-5720-20 + - 5g-149-5745-20 + - 5g-151-5755-40 + - 5g-153-5765-20 + - 5g-155-5775-80 + - 5g-157-5785-20 + - 5g-159-5795-40 + - 5g-161-5805-20 + - 5g-163-5815-160 + - 5g-165-5825-20 + - 5g-167-5835-40 + - 5g-169-5845-20 + - 5g-171-5855-80 + - 5g-173-5865-20 + - 5g-175-5875-40 + - 5g-177-5885-20 + - 6g-1-5955-20 + - 6g-3-5965-40 + - 6g-5-5975-20 + - 6g-7-5985-80 + - 6g-9-5995-20 + - 6g-11-6005-40 + - 6g-13-6015-20 + - 6g-15-6025-160 + - 6g-17-6035-20 + - 6g-19-6045-40 + - 6g-21-6055-20 + - 6g-23-6065-80 + - 6g-25-6075-20 + - 6g-27-6085-40 + - 6g-29-6095-20 + - 6g-31-6105-320 + - 6g-33-6115-20 + - 6g-35-6125-40 + - 6g-37-6135-20 + - 6g-39-6145-80 + - 6g-41-6155-20 + - 6g-43-6165-40 + - 6g-45-6175-20 + - 6g-47-6185-160 + - 6g-49-6195-20 + - 6g-51-6205-40 + - 6g-53-6215-20 + - 6g-55-6225-80 + - 6g-57-6235-20 + - 6g-59-6245-40 + - 6g-61-6255-20 + - 6g-65-6275-20 + - 6g-67-6285-40 + - 6g-69-6295-20 + - 6g-71-6305-80 + - 6g-73-6315-20 + - 6g-75-6325-40 + - 6g-77-6335-20 + - 6g-79-6345-160 + - 6g-81-6355-20 + - 6g-83-6365-40 + - 6g-85-6375-20 + - 6g-87-6385-80 + - 6g-89-6395-20 + - 6g-91-6405-40 + - 6g-93-6415-20 + - 6g-95-6425-320 + - 6g-97-6435-20 + - 6g-99-6445-40 + - 6g-101-6455-20 + - 6g-103-6465-80 + - 6g-105-6475-20 + - 6g-107-6485-40 + - 6g-109-6495-20 + - 6g-111-6505-160 + - 6g-113-6515-20 + - 6g-115-6525-40 + - 6g-117-6535-20 + - 6g-119-6545-80 + - 6g-121-6555-20 + - 6g-123-6565-40 + - 6g-125-6575-20 + - 6g-129-6595-20 + - 6g-131-6605-40 + - 6g-133-6615-20 + - 6g-135-6625-80 + - 6g-137-6635-20 + - 6g-139-6645-40 + - 6g-141-6655-20 + - 6g-143-6665-160 + - 6g-145-6675-20 + - 6g-147-6685-40 + - 6g-149-6695-20 + - 6g-151-6705-80 + - 6g-153-6715-20 + - 6g-155-6725-40 + - 6g-157-6735-20 + - 6g-159-6745-320 + - 6g-161-6755-20 + - 6g-163-6765-40 + - 6g-165-6775-20 + - 6g-167-6785-80 + - 6g-169-6795-20 + - 6g-171-6805-40 + - 6g-173-6815-20 + - 6g-175-6825-160 + - 6g-177-6835-20 + - 6g-179-6845-40 + - 6g-181-6855-20 + - 6g-183-6865-80 + - 6g-185-6875-20 + - 6g-187-6885-40 + - 6g-189-6895-20 + - 6g-193-6915-20 + - 6g-195-6925-40 + - 6g-197-6935-20 + - 6g-199-6945-80 + - 6g-201-6955-20 + - 6g-203-6965-40 + - 6g-205-6975-20 + - 6g-207-6985-160 + - 6g-209-6995-20 + - 6g-211-7005-40 + - 6g-213-7015-20 + - 6g-215-7025-80 + - 6g-217-7035-20 + - 6g-219-7045-40 + - 6g-221-7055-20 + - 6g-225-7075-20 + - 6g-227-7085-40 + - 6g-229-7095-20 + - 6g-233-7115-20 + - 60g-1-58320-2160 + - 60g-2-60480-2160 + - 60g-3-62640-2160 + - 60g-4-64800-2160 + - 60g-5-66960-2160 + - 60g-6-69120-2160 + - 60g-9-59400-4320 + - 60g-10-61560-4320 + - 60g-11-63720-4320 + - 60g-12-65880-4320 + - 60g-13-68040-4320 + - 60g-17-60480-6480 + - 60g-18-62640-6480 + - 60g-19-64800-6480 + - 60g-20-66960-6480 + - 60g-25-61560-6480 + - 60g-26-63720-6480 + - 60g-27-65880-6480 + - '' + - null + type: string + description: |- + * `2.4g-1-2412-22` - 1 (2412 MHz) + * `2.4g-2-2417-22` - 2 (2417 MHz) + * `2.4g-3-2422-22` - 3 (2422 MHz) + * `2.4g-4-2427-22` - 4 (2427 MHz) + * `2.4g-5-2432-22` - 5 (2432 MHz) + * `2.4g-6-2437-22` - 6 (2437 MHz) + * `2.4g-7-2442-22` - 7 (2442 MHz) + * `2.4g-8-2447-22` - 8 (2447 MHz) + * `2.4g-9-2452-22` - 9 (2452 MHz) + * `2.4g-10-2457-22` - 10 (2457 MHz) + * `2.4g-11-2462-22` - 11 (2462 MHz) + * `2.4g-12-2467-22` - 12 (2467 MHz) + * `2.4g-13-2472-22` - 13 (2472 MHz) + * `5g-32-5160-20` - 32 (5160/20 MHz) + * `5g-34-5170-40` - 34 (5170/40 MHz) + * `5g-36-5180-20` - 36 (5180/20 MHz) + * `5g-38-5190-40` - 38 (5190/40 MHz) + * `5g-40-5200-20` - 40 (5200/20 MHz) + * `5g-42-5210-80` - 42 (5210/80 MHz) + * `5g-44-5220-20` - 44 (5220/20 MHz) + * `5g-46-5230-40` - 46 (5230/40 MHz) + * `5g-48-5240-20` - 48 (5240/20 MHz) + * `5g-50-5250-160` - 50 (5250/160 MHz) + * `5g-52-5260-20` - 52 (5260/20 MHz) + * `5g-54-5270-40` - 54 (5270/40 MHz) + * `5g-56-5280-20` - 56 (5280/20 MHz) + * `5g-58-5290-80` - 58 (5290/80 MHz) + * `5g-60-5300-20` - 60 (5300/20 MHz) + * `5g-62-5310-40` - 62 (5310/40 MHz) + * `5g-64-5320-20` - 64 (5320/20 MHz) + * `5g-100-5500-20` - 100 (5500/20 MHz) + * `5g-102-5510-40` - 102 (5510/40 MHz) + * `5g-104-5520-20` - 104 (5520/20 MHz) + * `5g-106-5530-80` - 106 (5530/80 MHz) + * `5g-108-5540-20` - 108 (5540/20 MHz) + * `5g-110-5550-40` - 110 (5550/40 MHz) + * `5g-112-5560-20` - 112 (5560/20 MHz) + * `5g-114-5570-160` - 114 (5570/160 MHz) + * `5g-116-5580-20` - 116 (5580/20 MHz) + * `5g-118-5590-40` - 118 (5590/40 MHz) + * `5g-120-5600-20` - 120 (5600/20 MHz) + * `5g-122-5610-80` - 122 (5610/80 MHz) + * `5g-124-5620-20` - 124 (5620/20 MHz) + * `5g-126-5630-40` - 126 (5630/40 MHz) + * `5g-128-5640-20` - 128 (5640/20 MHz) + * `5g-132-5660-20` - 132 (5660/20 MHz) + * `5g-134-5670-40` - 134 (5670/40 MHz) + * `5g-136-5680-20` - 136 (5680/20 MHz) + * `5g-138-5690-80` - 138 (5690/80 MHz) + * `5g-140-5700-20` - 140 (5700/20 MHz) + * `5g-142-5710-40` - 142 (5710/40 MHz) + * `5g-144-5720-20` - 144 (5720/20 MHz) + * `5g-149-5745-20` - 149 (5745/20 MHz) + * `5g-151-5755-40` - 151 (5755/40 MHz) + * `5g-153-5765-20` - 153 (5765/20 MHz) + * `5g-155-5775-80` - 155 (5775/80 MHz) + * `5g-157-5785-20` - 157 (5785/20 MHz) + * `5g-159-5795-40` - 159 (5795/40 MHz) + * `5g-161-5805-20` - 161 (5805/20 MHz) + * `5g-163-5815-160` - 163 (5815/160 MHz) + * `5g-165-5825-20` - 165 (5825/20 MHz) + * `5g-167-5835-40` - 167 (5835/40 MHz) + * `5g-169-5845-20` - 169 (5845/20 MHz) + * `5g-171-5855-80` - 171 (5855/80 MHz) + * `5g-173-5865-20` - 173 (5865/20 MHz) + * `5g-175-5875-40` - 175 (5875/40 MHz) + * `5g-177-5885-20` - 177 (5885/20 MHz) + * `6g-1-5955-20` - 1 (5955/20 MHz) + * `6g-3-5965-40` - 3 (5965/40 MHz) + * `6g-5-5975-20` - 5 (5975/20 MHz) + * `6g-7-5985-80` - 7 (5985/80 MHz) + * `6g-9-5995-20` - 9 (5995/20 MHz) + * `6g-11-6005-40` - 11 (6005/40 MHz) + * `6g-13-6015-20` - 13 (6015/20 MHz) + * `6g-15-6025-160` - 15 (6025/160 MHz) + * `6g-17-6035-20` - 17 (6035/20 MHz) + * `6g-19-6045-40` - 19 (6045/40 MHz) + * `6g-21-6055-20` - 21 (6055/20 MHz) + * `6g-23-6065-80` - 23 (6065/80 MHz) + * `6g-25-6075-20` - 25 (6075/20 MHz) + * `6g-27-6085-40` - 27 (6085/40 MHz) + * `6g-29-6095-20` - 29 (6095/20 MHz) + * `6g-31-6105-320` - 31 (6105/320 MHz) + * `6g-33-6115-20` - 33 (6115/20 MHz) + * `6g-35-6125-40` - 35 (6125/40 MHz) + * `6g-37-6135-20` - 37 (6135/20 MHz) + * `6g-39-6145-80` - 39 (6145/80 MHz) + * `6g-41-6155-20` - 41 (6155/20 MHz) + * `6g-43-6165-40` - 43 (6165/40 MHz) + * `6g-45-6175-20` - 45 (6175/20 MHz) + * `6g-47-6185-160` - 47 (6185/160 MHz) + * `6g-49-6195-20` - 49 (6195/20 MHz) + * `6g-51-6205-40` - 51 (6205/40 MHz) + * `6g-53-6215-20` - 53 (6215/20 MHz) + * `6g-55-6225-80` - 55 (6225/80 MHz) + * `6g-57-6235-20` - 57 (6235/20 MHz) + * `6g-59-6245-40` - 59 (6245/40 MHz) + * `6g-61-6255-20` - 61 (6255/20 MHz) + * `6g-65-6275-20` - 65 (6275/20 MHz) + * `6g-67-6285-40` - 67 (6285/40 MHz) + * `6g-69-6295-20` - 69 (6295/20 MHz) + * `6g-71-6305-80` - 71 (6305/80 MHz) + * `6g-73-6315-20` - 73 (6315/20 MHz) + * `6g-75-6325-40` - 75 (6325/40 MHz) + * `6g-77-6335-20` - 77 (6335/20 MHz) + * `6g-79-6345-160` - 79 (6345/160 MHz) + * `6g-81-6355-20` - 81 (6355/20 MHz) + * `6g-83-6365-40` - 83 (6365/40 MHz) + * `6g-85-6375-20` - 85 (6375/20 MHz) + * `6g-87-6385-80` - 87 (6385/80 MHz) + * `6g-89-6395-20` - 89 (6395/20 MHz) + * `6g-91-6405-40` - 91 (6405/40 MHz) + * `6g-93-6415-20` - 93 (6415/20 MHz) + * `6g-95-6425-320` - 95 (6425/320 MHz) + * `6g-97-6435-20` - 97 (6435/20 MHz) + * `6g-99-6445-40` - 99 (6445/40 MHz) + * `6g-101-6455-20` - 101 (6455/20 MHz) + * `6g-103-6465-80` - 103 (6465/80 MHz) + * `6g-105-6475-20` - 105 (6475/20 MHz) + * `6g-107-6485-40` - 107 (6485/40 MHz) + * `6g-109-6495-20` - 109 (6495/20 MHz) + * `6g-111-6505-160` - 111 (6505/160 MHz) + * `6g-113-6515-20` - 113 (6515/20 MHz) + * `6g-115-6525-40` - 115 (6525/40 MHz) + * `6g-117-6535-20` - 117 (6535/20 MHz) + * `6g-119-6545-80` - 119 (6545/80 MHz) + * `6g-121-6555-20` - 121 (6555/20 MHz) + * `6g-123-6565-40` - 123 (6565/40 MHz) + * `6g-125-6575-20` - 125 (6575/20 MHz) + * `6g-129-6595-20` - 129 (6595/20 MHz) + * `6g-131-6605-40` - 131 (6605/40 MHz) + * `6g-133-6615-20` - 133 (6615/20 MHz) + * `6g-135-6625-80` - 135 (6625/80 MHz) + * `6g-137-6635-20` - 137 (6635/20 MHz) + * `6g-139-6645-40` - 139 (6645/40 MHz) + * `6g-141-6655-20` - 141 (6655/20 MHz) + * `6g-143-6665-160` - 143 (6665/160 MHz) + * `6g-145-6675-20` - 145 (6675/20 MHz) + * `6g-147-6685-40` - 147 (6685/40 MHz) + * `6g-149-6695-20` - 149 (6695/20 MHz) + * `6g-151-6705-80` - 151 (6705/80 MHz) + * `6g-153-6715-20` - 153 (6715/20 MHz) + * `6g-155-6725-40` - 155 (6725/40 MHz) + * `6g-157-6735-20` - 157 (6735/20 MHz) + * `6g-159-6745-320` - 159 (6745/320 MHz) + * `6g-161-6755-20` - 161 (6755/20 MHz) + * `6g-163-6765-40` - 163 (6765/40 MHz) + * `6g-165-6775-20` - 165 (6775/20 MHz) + * `6g-167-6785-80` - 167 (6785/80 MHz) + * `6g-169-6795-20` - 169 (6795/20 MHz) + * `6g-171-6805-40` - 171 (6805/40 MHz) + * `6g-173-6815-20` - 173 (6815/20 MHz) + * `6g-175-6825-160` - 175 (6825/160 MHz) + * `6g-177-6835-20` - 177 (6835/20 MHz) + * `6g-179-6845-40` - 179 (6845/40 MHz) + * `6g-181-6855-20` - 181 (6855/20 MHz) + * `6g-183-6865-80` - 183 (6865/80 MHz) + * `6g-185-6875-20` - 185 (6875/20 MHz) + * `6g-187-6885-40` - 187 (6885/40 MHz) + * `6g-189-6895-20` - 189 (6895/20 MHz) + * `6g-193-6915-20` - 193 (6915/20 MHz) + * `6g-195-6925-40` - 195 (6925/40 MHz) + * `6g-197-6935-20` - 197 (6935/20 MHz) + * `6g-199-6945-80` - 199 (6945/80 MHz) + * `6g-201-6955-20` - 201 (6955/20 MHz) + * `6g-203-6965-40` - 203 (6965/40 MHz) + * `6g-205-6975-20` - 205 (6975/20 MHz) + * `6g-207-6985-160` - 207 (6985/160 MHz) + * `6g-209-6995-20` - 209 (6995/20 MHz) + * `6g-211-7005-40` - 211 (7005/40 MHz) + * `6g-213-7015-20` - 213 (7015/20 MHz) + * `6g-215-7025-80` - 215 (7025/80 MHz) + * `6g-217-7035-20` - 217 (7035/20 MHz) + * `6g-219-7045-40` - 219 (7045/40 MHz) + * `6g-221-7055-20` - 221 (7055/20 MHz) + * `6g-225-7075-20` - 225 (7075/20 MHz) + * `6g-227-7085-40` - 227 (7085/40 MHz) + * `6g-229-7095-20` - 229 (7095/20 MHz) + * `6g-233-7115-20` - 233 (7115/20 MHz) + * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) + * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) + * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) + * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) + * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) + * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) + * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) + * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) + * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) + * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) + * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) + * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) + * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) + * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) + * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) + * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) + * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) + * `60g-27-65880-6480` - 27 (65.88/8.64 GHz) + x-spec-enum-id: 70cf66176c475063 + nullable: true + title: Wireless channel + poe_mode: + enum: + - pd + - pse + - '' + - null + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + poe_type: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + - null + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + nullable: true + rf_channel_frequency: + type: number + format: double + maximum: 100000 + minimum: -100000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel frequency (MHz) + description: Populated by selected channel (if set) + rf_channel_width: + type: number + format: double + maximum: 10000 + minimum: -10000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + title: Channel width (MHz) + description: Populated by selected channel (if set) + tx_power: + type: integer + maximum: 127 + minimum: -40 + nullable: true + title: Transmit power (dBm) + untagged_vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + tagged_vlans: + type: array + items: + type: integer + qinq_svlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + vlan_translation_policy: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' + nullable: true + nullable: true + mark_connected: + type: boolean + description: Treat as if a cable is connected + wireless_lans: + type: array + items: + type: integer + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - type + WritableInterfaceTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - virtual + - bridge + - lag + - 100base-fx + - 100base-lfx + - 100base-tx + - 100base-t1 + - 1000base-bx10-d + - 1000base-bx10-u + - 1000base-cwdm + - 1000base-cx + - 1000base-dwdm + - 1000base-ex + - 1000base-lsx + - 1000base-lx + - 1000base-lx10 + - 1000base-sx + - 1000base-t + - 1000base-tx + - 1000base-zx + - 2.5gbase-t + - 5gbase-t + - 10gbase-br-d + - 10gbase-br-u + - 10gbase-cu + - 10gbase-cx4 + - 10gbase-er + - 10gbase-lr + - 10gbase-lrm + - 10gbase-lx4 + - 10gbase-sr + - 10gbase-t + - 10gbase-zr + - 25gbase-cr + - 25gbase-er + - 25gbase-lr + - 25gbase-sr + - 25gbase-t + - 40gbase-cr4 + - 40gbase-er4 + - 40gbase-fr4 + - 40gbase-lr4 + - 40gbase-sr4 + - 40gbase-sr4-bd + - 50gbase-cr + - 50gbase-er + - 50gbase-fr + - 50gbase-lr + - 50gbase-sr + - 100gbase-cr1 + - 100gbase-cr2 + - 100gbase-cr4 + - 100gbase-cr10 + - 100gbase-cwdm4 + - 100gbase-dr + - 100gbase-er4 + - 100gbase-fr1 + - 100gbase-lr1 + - 100gbase-lr4 + - 100gbase-sr1 + - 100gbase-sr1.2 + - 100gbase-sr2 + - 100gbase-sr4 + - 100gbase-sr10 + - 100gbase-zr + - 200gbase-cr2 + - 200gbase-cr4 + - 200gbase-dr4 + - 200gbase-er4 + - 200gbase-fr4 + - 200gbase-lr4 + - 200gbase-sr2 + - 200gbase-sr4 + - 200gbase-vr2 + - 400gbase-cr4 + - 400gbase-dr4 + - 400gbase-er8 + - 400gbase-fr4 + - 400gbase-fr8 + - 400gbase-lr4 + - 400gbase-lr8 + - 400gbase-sr4 + - 400gbase-sr4_2 + - 400gbase-sr8 + - 400gbase-sr16 + - 400gbase-vr4 + - 400gbase-zr + - 800gbase-cr8 + - 800gbase-dr8 + - 800gbase-sr8 + - 800gbase-vr8 + - 1.6tbase-cr8 + - 1.6tbase-dr8 + - 1.6tbase-dr8-2 + - 100base-x-sfp + - 1000base-x-gbic + - 1000base-x-sfp + - 2.5gbase-x-sfp + - 10gbase-x-sfpp + - 10gbase-x-xenpak + - 10gbase-x-xfp + - 10gbase-x-x2 + - 25gbase-x-sfp28 + - 40gbase-x-qsfpp + - 50gbase-x-sfp28 + - 50gbase-x-sfp56 + - 100gbase-x-cfp + - 100gbase-x-cfp2 + - 100gbase-x-cfp4 + - 100gbase-x-cxp + - 100gbase-x-cpak + - 100gbase-x-dsfp + - 100gbase-x-qsfp28 + - 100gbase-x-qsfpdd + - 100gbase-x-sfpdd + - 200gbase-x-cfp2 + - 200gbase-x-qsfp56 + - 200gbase-x-qsfpdd + - 400gbase-x-qsfp112 + - 400gbase-x-qsfpdd + - 400gbase-x-cdfp + - 400gbase-x-cfp2 + - 400gbase-x-cfp8 + - 400gbase-x-osfp + - 400gbase-x-osfp-rhs + - 800gbase-x-osfp + - 800gbase-x-qsfpdd + - 1.6tbase-x-osfp1600 + - 1.6tbase-x-osfp1600-rhs + - 1.6tbase-x-qsfpdd1600 + - 1000base-kx + - 2.5gbase-kx + - 5gbase-kr + - 10gbase-kr + - 10gbase-kx4 + - 25gbase-kr + - 40gbase-kr4 + - 50gbase-kr + - 100gbase-kp4 + - 100gbase-kr2 + - 100gbase-kr4 + - 1.6tbase-kr8 + - ieee802.11a + - ieee802.11g + - ieee802.11n + - ieee802.11ac + - ieee802.11ad + - ieee802.11ax + - ieee802.11ay + - ieee802.11be + - ieee802.15.1 + - ieee802.15.4 + - other-wireless + - gsm + - cdma + - lte + - 4g + - 5g + - sonet-oc3 + - sonet-oc12 + - sonet-oc48 + - sonet-oc192 + - sonet-oc768 + - sonet-oc1920 + - sonet-oc3840 + - 1gfc-sfp + - 2gfc-sfp + - 4gfc-sfp + - 8gfc-sfpp + - 16gfc-sfpp + - 32gfc-sfp28 + - 32gfc-sfpp + - 64gfc-qsfpp + - 64gfc-sfpdd + - 64gfc-sfpp + - 128gfc-qsfp28 + - infiniband-sdr + - infiniband-ddr + - infiniband-qdr + - infiniband-fdr10 + - infiniband-fdr + - infiniband-edr + - infiniband-hdr + - infiniband-ndr + - infiniband-xdr + - t1 + - e1 + - t3 + - e3 + - xdsl + - docsis + - moca + - bpon + - epon + - 10g-epon + - gpon + - xg-pon + - xgs-pon + - ng-pon2 + - 25g-pon + - 50g-pon + - cisco-stackwise + - cisco-stackwise-plus + - cisco-flexstack + - cisco-flexstack-plus + - cisco-stackwise-80 + - cisco-stackwise-160 + - cisco-stackwise-320 + - cisco-stackwise-480 + - cisco-stackwise-1t + - juniper-vcp + - extreme-summitstack + - extreme-summitstack-128 + - extreme-summitstack-256 + - extreme-summitstack-512 + - other + type: string + description: |- + * `virtual` - Virtual + * `bridge` - Bridge + * `lag` - Link Aggregation Group (LAG) + * `100base-fx` - 100BASE-FX (10/100ME) + * `100base-lfx` - 100BASE-LFX (10/100ME) + * `100base-tx` - 100BASE-TX (10/100ME) + * `100base-t1` - 100BASE-T1 (10/100ME) + * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) + * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) + * `1000base-cwdm` - 1000BASE-CWDM (1GE) + * `1000base-cx` - 1000BASE-CX (1GE DAC) + * `1000base-dwdm` - 1000BASE-DWDM (1GE) + * `1000base-ex` - 1000BASE-EX (1GE) + * `1000base-lsx` - 1000BASE-LSX (1GE) + * `1000base-lx` - 1000BASE-LX (1GE) + * `1000base-lx10` - 1000BASE-LX10/LH (1GE) + * `1000base-sx` - 1000BASE-SX (1GE) + * `1000base-t` - 1000BASE-T (1GE) + * `1000base-tx` - 1000BASE-TX (1GE) + * `1000base-zx` - 1000BASE-ZX (1GE) + * `2.5gbase-t` - 2.5GBASE-T (2.5GE) + * `5gbase-t` - 5GBASE-T (5GE) + * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) + * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) + * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) + * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) + * `10gbase-er` - 10GBASE-ER (10GE) + * `10gbase-lr` - 10GBASE-LR (10GE) + * `10gbase-lrm` - 10GBASE-LRM (10GE) + * `10gbase-lx4` - 10GBASE-LX4 (10GE) + * `10gbase-sr` - 10GBASE-SR (10GE) + * `10gbase-t` - 10GBASE-T (10GE) + * `10gbase-zr` - 10GBASE-ZR (10GE) + * `25gbase-cr` - 25GBASE-CR (25GE DAC) + * `25gbase-er` - 25GBASE-ER (25GE) + * `25gbase-lr` - 25GBASE-LR (25GE) + * `25gbase-sr` - 25GBASE-SR (25GE) + * `25gbase-t` - 25GBASE-T (25GE) + * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) + * `40gbase-er4` - 40GBASE-ER4 (40GE) + * `40gbase-fr4` - 40GBASE-FR4 (40GE) + * `40gbase-lr4` - 40GBASE-LR4 (40GE) + * `40gbase-sr4` - 40GBASE-SR4 (40GE) + * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) + * `50gbase-cr` - 50GBASE-CR (50GE DAC) + * `50gbase-er` - 50GBASE-ER (50GE) + * `50gbase-fr` - 50GBASE-FR (50GE) + * `50gbase-lr` - 50GBASE-LR (50GE) + * `50gbase-sr` - 50GBASE-SR (50GE) + * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) + * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) + * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) + * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) + * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) + * `100gbase-dr` - 100GBASE-DR (100GE) + * `100gbase-er4` - 100GBASE-ER4 (100GE) + * `100gbase-fr1` - 100GBASE-FR1 (100GE) + * `100gbase-lr1` - 100GBASE-LR1 (100GE) + * `100gbase-lr4` - 100GBASE-LR4 (100GE) + * `100gbase-sr1` - 100GBASE-SR1 (100GE) + * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) + * `100gbase-sr2` - 100GBASE-SR2 (100GE) + * `100gbase-sr4` - 100GBASE-SR4 (100GE) + * `100gbase-sr10` - 100GBASE-SR10 (100GE) + * `100gbase-zr` - 100GBASE-ZR (100GE) + * `200gbase-cr2` - 200GBASE-CR2 (200GE) + * `200gbase-cr4` - 200GBASE-CR4 (200GE) + * `200gbase-dr4` - 200GBASE-DR4 (200GE) + * `200gbase-er4` - 200GBASE-ER4 (200GE) + * `200gbase-fr4` - 200GBASE-FR4 (200GE) + * `200gbase-lr4` - 200GBASE-LR4 (200GE) + * `200gbase-sr2` - 200GBASE-SR2 (200GE) + * `200gbase-sr4` - 200GBASE-SR4 (200GE) + * `200gbase-vr2` - 200GBASE-VR2 (200GE) + * `400gbase-cr4` - 400GBASE-CR4 (400GE) + * `400gbase-dr4` - 400GBASE-DR4 (400GE) + * `400gbase-er8` - 400GBASE-ER8 (400GE) + * `400gbase-fr4` - 400GBASE-FR4 (400GE) + * `400gbase-fr8` - 400GBASE-FR8 (400GE) + * `400gbase-lr4` - 400GBASE-LR4 (400GE) + * `400gbase-lr8` - 400GBASE-LR8 (400GE) + * `400gbase-sr4` - 400GBASE-SR4 (400GE) + * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) + * `400gbase-sr8` - 400GBASE-SR8 (400GE) + * `400gbase-sr16` - 400GBASE-SR16 (400GE) + * `400gbase-vr4` - 400GBASE-VR4 (400GE) + * `400gbase-zr` - 400GBASE-ZR (400GE) + * `800gbase-cr8` - 800GBASE-CR8 (800GE) + * `800gbase-dr8` - 800GBASE-DR8 (800GE) + * `800gbase-sr8` - 800GBASE-SR8 (800GE) + * `800gbase-vr8` - 800GBASE-VR8 (800GE) + * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) + * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) + * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) + * `100base-x-sfp` - SFP (100ME) + * `1000base-x-gbic` - GBIC (1GE) + * `1000base-x-sfp` - SFP (1GE) + * `2.5gbase-x-sfp` - SFP (2.5GE) + * `10gbase-x-sfpp` - SFP+ (10GE) + * `10gbase-x-xenpak` - XENPAK (10GE) + * `10gbase-x-xfp` - XFP (10GE) + * `10gbase-x-x2` - X2 (10GE) + * `25gbase-x-sfp28` - SFP28 (25GE) + * `40gbase-x-qsfpp` - QSFP+ (40GE) + * `50gbase-x-sfp28` - QSFP28 (50GE) + * `50gbase-x-sfp56` - SFP56 (50GE) + * `100gbase-x-cfp` - CFP (100GE) + * `100gbase-x-cfp2` - CFP2 (100GE) + * `100gbase-x-cfp4` - CFP4 (100GE) + * `100gbase-x-cxp` - CXP (100GE) + * `100gbase-x-cpak` - Cisco CPAK (100GE) + * `100gbase-x-dsfp` - DSFP (100GE) + * `100gbase-x-qsfp28` - QSFP28 (100GE) + * `100gbase-x-qsfpdd` - QSFP-DD (100GE) + * `100gbase-x-sfpdd` - SFP-DD (100GE) + * `200gbase-x-cfp2` - CFP2 (200GE) + * `200gbase-x-qsfp56` - QSFP56 (200GE) + * `200gbase-x-qsfpdd` - QSFP-DD (200GE) + * `400gbase-x-qsfp112` - QSFP112 (400GE) + * `400gbase-x-qsfpdd` - QSFP-DD (400GE) + * `400gbase-x-cdfp` - CDFP (400GE) + * `400gbase-x-cfp2` - CFP2 (400GE) + * `400gbase-x-cfp8` - CPF8 (400GE) + * `400gbase-x-osfp` - OSFP (400GE) + * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) + * `800gbase-x-osfp` - OSFP (800GE) + * `800gbase-x-qsfpdd` - QSFP-DD (800GE) + * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) + * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) + * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) + * `1000base-kx` - 1000BASE-KX (1GE) + * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) + * `5gbase-kr` - 5GBASE-KR (5GE) + * `10gbase-kr` - 10GBASE-KR (10GE) + * `10gbase-kx4` - 10GBASE-KX4 (10GE) + * `25gbase-kr` - 25GBASE-KR (25GE) + * `40gbase-kr4` - 40GBASE-KR4 (40GE) + * `50gbase-kr` - 50GBASE-KR (50GE) + * `100gbase-kp4` - 100GBASE-KP4 (100GE) + * `100gbase-kr2` - 100GBASE-KR2 (100GE) + * `100gbase-kr4` - 100GBASE-KR4 (100GE) + * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) + * `ieee802.11a` - IEEE 802.11a + * `ieee802.11g` - IEEE 802.11b/g + * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) + * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) + * `ieee802.11ad` - IEEE 802.11ad (WiGig) + * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) + * `ieee802.11ay` - IEEE 802.11ay (WiGig) + * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) + * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) + * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) + * `other-wireless` - Other (Wireless) + * `gsm` - GSM + * `cdma` - CDMA + * `lte` - LTE + * `4g` - 4G + * `5g` - 5G + * `sonet-oc3` - OC-3/STM-1 + * `sonet-oc12` - OC-12/STM-4 + * `sonet-oc48` - OC-48/STM-16 + * `sonet-oc192` - OC-192/STM-64 + * `sonet-oc768` - OC-768/STM-256 + * `sonet-oc1920` - OC-1920/STM-640 + * `sonet-oc3840` - OC-3840/STM-1234 + * `1gfc-sfp` - SFP (1GFC) + * `2gfc-sfp` - SFP (2GFC) + * `4gfc-sfp` - SFP (4GFC) + * `8gfc-sfpp` - SFP+ (8GFC) + * `16gfc-sfpp` - SFP+ (16GFC) + * `32gfc-sfp28` - SFP28 (32GFC) + * `32gfc-sfpp` - SFP+ (32GFC) + * `64gfc-qsfpp` - QSFP+ (64GFC) + * `64gfc-sfpdd` - SFP-DD (64GFC) + * `64gfc-sfpp` - SFP+ (64GFC) + * `128gfc-qsfp28` - QSFP28 (128GFC) + * `infiniband-sdr` - SDR (2 Gbps) + * `infiniband-ddr` - DDR (4 Gbps) + * `infiniband-qdr` - QDR (8 Gbps) + * `infiniband-fdr10` - FDR10 (10 Gbps) + * `infiniband-fdr` - FDR (13.5 Gbps) + * `infiniband-edr` - EDR (25 Gbps) + * `infiniband-hdr` - HDR (50 Gbps) + * `infiniband-ndr` - NDR (100 Gbps) + * `infiniband-xdr` - XDR (250 Gbps) + * `t1` - T1 (1.544 Mbps) + * `e1` - E1 (2.048 Mbps) + * `t3` - T3 (45 Mbps) + * `e3` - E3 (34 Mbps) + * `xdsl` - xDSL + * `docsis` - DOCSIS + * `moca` - MoCA + * `bpon` - BPON (622 Mbps / 155 Mbps) + * `epon` - EPON (1 Gbps) + * `10g-epon` - 10G-EPON (10 Gbps) + * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) + * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) + * `xgs-pon` - XGS-PON (10 Gbps) + * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) + * `25g-pon` - 25G-PON (25 Gbps) + * `50g-pon` - 50G-PON (50 Gbps) + * `cisco-stackwise` - Cisco StackWise + * `cisco-stackwise-plus` - Cisco StackWise Plus + * `cisco-flexstack` - Cisco FlexStack + * `cisco-flexstack-plus` - Cisco FlexStack Plus + * `cisco-stackwise-80` - Cisco StackWise-80 + * `cisco-stackwise-160` - Cisco StackWise-160 + * `cisco-stackwise-320` - Cisco StackWise-320 + * `cisco-stackwise-480` - Cisco StackWise-480 + * `cisco-stackwise-1t` - Cisco StackWise-1T + * `juniper-vcp` - Juniper VCP + * `extreme-summitstack` - Extreme SummitStack + * `extreme-summitstack-128` - Extreme SummitStack-128 + * `extreme-summitstack-256` - Extreme SummitStack-256 + * `extreme-summitstack-512` - Extreme SummitStack-512 + * `other` - Other + x-spec-enum-id: b067eb1f050c6ae9 + enabled: + type: boolean + mgmt_only: + type: boolean + title: Management only + description: + type: string + maxLength: 200 + bridge: + type: integer + nullable: true + title: Bridge interface + poe_mode: + enum: + - pd + - pse + - '' + - null + type: string + description: |- + * `pd` - PD + * `pse` - PSE + x-spec-enum-id: 2f2fe6dcdc7772bd + nullable: true + poe_type: + enum: + - type1-ieee802.3af + - type2-ieee802.3at + - type3-ieee802.3bt + - type4-ieee802.3bt + - passive-24v-2pair + - passive-24v-4pair + - passive-48v-2pair + - passive-48v-4pair + - '' + - null + type: string + description: |- + * `type1-ieee802.3af` - 802.3af (Type 1) + * `type2-ieee802.3at` - 802.3at (Type 2) + * `type3-ieee802.3bt` - 802.3bt (Type 3) + * `type4-ieee802.3bt` - 802.3bt (Type 4) + * `passive-24v-2pair` - Passive 24V (2-pair) + * `passive-24v-4pair` - Passive 24V (4-pair) + * `passive-48v-2pair` - Passive 48V (2-pair) + * `passive-48v-4pair` - Passive 48V (4-pair) + x-spec-enum-id: 5473d57885f237ab + nullable: true + rf_role: + enum: + - ap + - station + - '' + - null + type: string + description: |- + * `ap` - Access point + * `station` - Station + x-spec-enum-id: d2772dbea88b0fb1 + nullable: true + title: Wireless role + required: + - name + - type + WritableInventoryItemRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + parent: + type: integer + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + part_id: + type: string + description: Manufacturer-assigned part identifier + maxLength: 50 + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this item + maxLength: 50 + discovered: + type: boolean + description: This item was automatically discovered + description: + type: string + maxLength: 200 + component_type: + type: string + nullable: true + component_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + WritableJournalEntryRequest: + type: object + description: Adds support for custom fields and tags. + properties: + assigned_object_type: + type: string + assigned_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + created_by: + type: integer + nullable: true + kind: + enum: + - info + - success + - warning + - danger + type: string + description: |- + * `info` - Info + * `success` - Success + * `warning` - Warning + * `danger` - Danger + x-spec-enum-id: 6f65abe0aab2c78c + comments: + type: string + minLength: 1 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - assigned_object_id + - assigned_object_type + - comments + WritableL2VPNRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + identifier: + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + format: int64 + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + type: + enum: + - vpws + - vpls + - vxlan + - vxlan-evpn + - mpls-evpn + - pbb-evpn + - evpn-vpws + - epl + - evpl + - ep-lan + - evp-lan + - ep-tree + - evp-tree + - spb + type: string + description: |- + * `vpws` - VPWS + * `vpls` - VPLS + * `vxlan` - VXLAN + * `vxlan-evpn` - VXLAN-EVPN + * `mpls-evpn` - MPLS EVPN + * `pbb-evpn` - PBB EVPN + * `evpn-vpws` - EVPN VPWS + * `epl` - EPL + * `evpl` - EVPL + * `ep-lan` - Ethernet Private LAN + * `evp-lan` - Ethernet Virtual Private LAN + * `ep-tree` - Ethernet Private Tree + * `evp-tree` - Ethernet Virtual Private Tree + * `spb` - SPB + x-spec-enum-id: 0a46f8056d717efc + status: + enum: + - active + - planned + - decommissioning + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 8b9dc8efc7c3d5b0 + import_targets: + type: array + items: + type: integer + export_targets: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + - type + WritableLocationRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + parent: + type: integer + nullable: true + status: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - site + - slug + WritableModuleRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module_bay: + type: integer + module_type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefModuleTypeRequest' + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + x-spec-enum-id: 545817eb4c4f2ae4 + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this device + maxLength: 50 + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + replicate_components: + type: boolean + writeOnly: true + default: true + description: 'Automatically populate components associated with this module + type (default: true)' + adopt_components: + type: boolean + writeOnly: true + default: false + description: Adopt already existing components + required: + - device + - module_bay + - module_type + WritableModuleTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' + nullable: true + nullable: true + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + part_number: + type: string + description: Discrete part number (optional) + maxLength: 50 + airflow: + enum: + - front-to-rear + - rear-to-front + - left-to-right + - right-to-left + - side-to-rear + - passive + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + * `left-to-right` - Left to right + * `right-to-left` - Right to left + * `side-to-rear` - Side to rear + * `passive` - Passive + x-spec-enum-id: 5ad4e700c656b09d + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + description: + type: string + maxLength: 200 + attributes: + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - manufacturer + - model + WritablePlatformRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + parent: + type: integer + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + manufacturer: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefManufacturerRequest' + nullable: true + nullable: true + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + WritablePowerFeedRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + power_panel: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefPowerPanelRequest' + rack: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 100 + status: + enum: + - offline + - active + - planned + - failed + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `failed` - Failed + x-spec-enum-id: ec530572dc778583 + type: + enum: + - primary + - redundant + type: string + description: |- + * `primary` - Primary + * `redundant` - Redundant + x-spec-enum-id: 093a164236819eb8 + supply: + enum: + - ac + - dc + type: string + description: |- + * `ac` - AC + * `dc` - DC + x-spec-enum-id: 1b6d99616ca6412b + phase: + enum: + - single-phase + - three-phase + type: string + description: |- + * `single-phase` - Single phase + * `three-phase` - Three-phase + x-spec-enum-id: 994bc0696f4df57f + voltage: + type: integer + maximum: 32767 + minimum: -32768 + amperage: + type: integer + maximum: 32767 + minimum: 1 + max_utilization: + type: integer + maximum: 100 + minimum: 1 + description: Maximum permissible draw (percentage) + mark_connected: + type: boolean + description: Treat as if a cable is connected + description: + type: string + maxLength: 200 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - power_panel + WritablePowerOutletRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + description: |- + Physical port type + + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + status: + enum: + - enabled + - disabled + - faulty + type: string + description: |- + * `enabled` - Enabled + * `disabled` - Disabled + * `faulty` - Faulty + x-spec-enum-id: d60dce16858f3c69 + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPowerPortRequest' + nullable: true + nullable: true + feed_leg: + enum: + - A + - B + - C + - '' + - null + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: |- + Phase (for three-phase feeds) + + * `A` - A + * `B` - B + * `C` - C + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + WritablePowerOutletTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c5 + - iec-60320-c7 + - iec-60320-c13 + - iec-60320-c15 + - iec-60320-c17 + - iec-60320-c19 + - iec-60320-c21 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15r + - nema-5-15r + - nema-5-20r + - nema-5-30r + - nema-5-50r + - nema-6-15r + - nema-6-20r + - nema-6-30r + - nema-6-50r + - nema-10-30r + - nema-10-50r + - nema-14-20r + - nema-14-30r + - nema-14-50r + - nema-14-60r + - nema-15-15r + - nema-15-20r + - nema-15-30r + - nema-15-50r + - nema-15-60r + - nema-l1-15r + - nema-l5-15r + - nema-l5-20r + - nema-l5-30r + - nema-l5-50r + - nema-l6-15r + - nema-l6-20r + - nema-l6-30r + - nema-l6-50r + - nema-l10-30r + - nema-l14-20r + - nema-l14-30r + - nema-l14-50r + - nema-l14-60r + - nema-l15-20r + - nema-l15-30r + - nema-l15-50r + - nema-l15-60r + - nema-l21-20r + - nema-l21-30r + - nema-l22-20r + - nema-l22-30r + - CS6360C + - CS6364C + - CS8164C + - CS8264C + - CS8364C + - CS8464C + - ita-e + - ita-f + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - ita-multistandard + - usb-a + - usb-micro-b + - usb-c + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - eaton-c39 + - hdot-cx + - saf-d-grid + - neutrik-powercon-20a + - neutrik-powercon-32a + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c5` - C5 + * `iec-60320-c7` - C7 + * `iec-60320-c13` - C13 + * `iec-60320-c15` - C15 + * `iec-60320-c17` - C17 + * `iec-60320-c19` - C19 + * `iec-60320-c21` - C21 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15r` - NEMA 1-15R + * `nema-5-15r` - NEMA 5-15R + * `nema-5-20r` - NEMA 5-20R + * `nema-5-30r` - NEMA 5-30R + * `nema-5-50r` - NEMA 5-50R + * `nema-6-15r` - NEMA 6-15R + * `nema-6-20r` - NEMA 6-20R + * `nema-6-30r` - NEMA 6-30R + * `nema-6-50r` - NEMA 6-50R + * `nema-10-30r` - NEMA 10-30R + * `nema-10-50r` - NEMA 10-50R + * `nema-14-20r` - NEMA 14-20R + * `nema-14-30r` - NEMA 14-30R + * `nema-14-50r` - NEMA 14-50R + * `nema-14-60r` - NEMA 14-60R + * `nema-15-15r` - NEMA 15-15R + * `nema-15-20r` - NEMA 15-20R + * `nema-15-30r` - NEMA 15-30R + * `nema-15-50r` - NEMA 15-50R + * `nema-15-60r` - NEMA 15-60R + * `nema-l1-15r` - NEMA L1-15R + * `nema-l5-15r` - NEMA L5-15R + * `nema-l5-20r` - NEMA L5-20R + * `nema-l5-30r` - NEMA L5-30R + * `nema-l5-50r` - NEMA L5-50R + * `nema-l6-15r` - NEMA L6-15R + * `nema-l6-20r` - NEMA L6-20R + * `nema-l6-30r` - NEMA L6-30R + * `nema-l6-50r` - NEMA L6-50R + * `nema-l10-30r` - NEMA L10-30R + * `nema-l14-20r` - NEMA L14-20R + * `nema-l14-30r` - NEMA L14-30R + * `nema-l14-50r` - NEMA L14-50R + * `nema-l14-60r` - NEMA L14-60R + * `nema-l15-20r` - NEMA L15-20R + * `nema-l15-30r` - NEMA L15-30R + * `nema-l15-50r` - NEMA L15-50R + * `nema-l15-60r` - NEMA L15-60R + * `nema-l21-20r` - NEMA L21-20R + * `nema-l21-30r` - NEMA L21-30R + * `nema-l22-20r` - NEMA L22-20R + * `nema-l22-30r` - NEMA L22-30R + * `CS6360C` - CS6360C + * `CS6364C` - CS6364C + * `CS8164C` - CS8164C + * `CS8264C` - CS8264C + * `CS8364C` - CS8364C + * `CS8464C` - CS8464C + * `ita-e` - ITA Type E (CEE 7/5) + * `ita-f` - ITA Type F (CEE 7/3) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `ita-multistandard` - ITA Multistandard + * `usb-a` - USB Type A + * `usb-micro-b` - USB Micro B + * `usb-c` - USB Type C + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `eaton-c39` - Eaton C39 + * `hdot-cx` - HDOT Cx + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20a` - Neutrik powerCON (20A) + * `neutrik-powercon-32a` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: db3e4eb2b93615f8 + nullable: true + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + power_port: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPowerPortTemplateRequest' + nullable: true + nullable: true + feed_leg: + enum: + - A + - B + - C + - '' + - null + type: string + x-spec-enum-id: a4902339df0b7c06 + nullable: true + description: |- + Phase (for three-phase feeds) + + * `A` - A + * `B` - B + * `C` - C + description: + type: string + maxLength: 200 + required: + - name + WritablePowerPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + description: |- + Physical port type + + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + WritablePowerPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - iec-60320-c6 + - iec-60320-c8 + - iec-60320-c14 + - iec-60320-c16 + - iec-60320-c18 + - iec-60320-c20 + - iec-60320-c22 + - iec-60309-p-n-e-4h + - iec-60309-p-n-e-6h + - iec-60309-p-n-e-9h + - iec-60309-2p-e-4h + - iec-60309-2p-e-6h + - iec-60309-2p-e-9h + - iec-60309-3p-e-4h + - iec-60309-3p-e-6h + - iec-60309-3p-e-9h + - iec-60309-3p-n-e-4h + - iec-60309-3p-n-e-6h + - iec-60309-3p-n-e-9h + - iec-60906-1 + - nbr-14136-10a + - nbr-14136-20a + - nema-1-15p + - nema-5-15p + - nema-5-20p + - nema-5-30p + - nema-5-50p + - nema-6-15p + - nema-6-20p + - nema-6-30p + - nema-6-50p + - nema-10-30p + - nema-10-50p + - nema-14-20p + - nema-14-30p + - nema-14-50p + - nema-14-60p + - nema-15-15p + - nema-15-20p + - nema-15-30p + - nema-15-50p + - nema-15-60p + - nema-l1-15p + - nema-l5-15p + - nema-l5-20p + - nema-l5-30p + - nema-l5-50p + - nema-l6-15p + - nema-l6-20p + - nema-l6-30p + - nema-l6-50p + - nema-l10-30p + - nema-l14-20p + - nema-l14-30p + - nema-l14-50p + - nema-l14-60p + - nema-l15-20p + - nema-l15-30p + - nema-l15-50p + - nema-l15-60p + - nema-l21-20p + - nema-l21-30p + - nema-l22-20p + - nema-l22-30p + - cs6361c + - cs6365c + - cs8165c + - cs8265c + - cs8365c + - cs8465c + - ita-c + - ita-e + - ita-f + - ita-ef + - ita-g + - ita-h + - ita-i + - ita-j + - ita-k + - ita-l + - ita-m + - ita-n + - ita-o + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - usb-3-b + - usb-3-micro-b + - molex-micro-fit-1x2 + - molex-micro-fit-2x2 + - molex-micro-fit-2x3 + - molex-micro-fit-2x4 + - dc-terminal + - saf-d-grid + - neutrik-powercon-20 + - neutrik-powercon-32 + - neutrik-powercon-true1 + - neutrik-powercon-true1-top + - ubiquiti-smartpower + - hardwired + - other + - '' + - null + type: string + description: |- + * `iec-60320-c6` - C6 + * `iec-60320-c8` - C8 + * `iec-60320-c14` - C14 + * `iec-60320-c16` - C16 + * `iec-60320-c18` - C18 + * `iec-60320-c20` - C20 + * `iec-60320-c22` - C22 + * `iec-60309-p-n-e-4h` - P+N+E 4H + * `iec-60309-p-n-e-6h` - P+N+E 6H + * `iec-60309-p-n-e-9h` - P+N+E 9H + * `iec-60309-2p-e-4h` - 2P+E 4H + * `iec-60309-2p-e-6h` - 2P+E 6H + * `iec-60309-2p-e-9h` - 2P+E 9H + * `iec-60309-3p-e-4h` - 3P+E 4H + * `iec-60309-3p-e-6h` - 3P+E 6H + * `iec-60309-3p-e-9h` - 3P+E 9H + * `iec-60309-3p-n-e-4h` - 3P+N+E 4H + * `iec-60309-3p-n-e-6h` - 3P+N+E 6H + * `iec-60309-3p-n-e-9h` - 3P+N+E 9H + * `iec-60906-1` - IEC 60906-1 + * `nbr-14136-10a` - 2P+T 10A (NBR 14136) + * `nbr-14136-20a` - 2P+T 20A (NBR 14136) + * `nema-1-15p` - NEMA 1-15P + * `nema-5-15p` - NEMA 5-15P + * `nema-5-20p` - NEMA 5-20P + * `nema-5-30p` - NEMA 5-30P + * `nema-5-50p` - NEMA 5-50P + * `nema-6-15p` - NEMA 6-15P + * `nema-6-20p` - NEMA 6-20P + * `nema-6-30p` - NEMA 6-30P + * `nema-6-50p` - NEMA 6-50P + * `nema-10-30p` - NEMA 10-30P + * `nema-10-50p` - NEMA 10-50P + * `nema-14-20p` - NEMA 14-20P + * `nema-14-30p` - NEMA 14-30P + * `nema-14-50p` - NEMA 14-50P + * `nema-14-60p` - NEMA 14-60P + * `nema-15-15p` - NEMA 15-15P + * `nema-15-20p` - NEMA 15-20P + * `nema-15-30p` - NEMA 15-30P + * `nema-15-50p` - NEMA 15-50P + * `nema-15-60p` - NEMA 15-60P + * `nema-l1-15p` - NEMA L1-15P + * `nema-l5-15p` - NEMA L5-15P + * `nema-l5-20p` - NEMA L5-20P + * `nema-l5-30p` - NEMA L5-30P + * `nema-l5-50p` - NEMA L5-50P + * `nema-l6-15p` - NEMA L6-15P + * `nema-l6-20p` - NEMA L6-20P + * `nema-l6-30p` - NEMA L6-30P + * `nema-l6-50p` - NEMA L6-50P + * `nema-l10-30p` - NEMA L10-30P + * `nema-l14-20p` - NEMA L14-20P + * `nema-l14-30p` - NEMA L14-30P + * `nema-l14-50p` - NEMA L14-50P + * `nema-l14-60p` - NEMA L14-60P + * `nema-l15-20p` - NEMA L15-20P + * `nema-l15-30p` - NEMA L15-30P + * `nema-l15-50p` - NEMA L15-50P + * `nema-l15-60p` - NEMA L15-60P + * `nema-l21-20p` - NEMA L21-20P + * `nema-l21-30p` - NEMA L21-30P + * `nema-l22-20p` - NEMA L22-20P + * `nema-l22-30p` - NEMA L22-30P + * `cs6361c` - CS6361C + * `cs6365c` - CS6365C + * `cs8165c` - CS8165C + * `cs8265c` - CS8265C + * `cs8365c` - CS8365C + * `cs8465c` - CS8465C + * `ita-c` - ITA Type C (CEE 7/16) + * `ita-e` - ITA Type E (CEE 7/6) + * `ita-f` - ITA Type F (CEE 7/4) + * `ita-ef` - ITA Type E/F (CEE 7/7) + * `ita-g` - ITA Type G (BS 1363) + * `ita-h` - ITA Type H + * `ita-i` - ITA Type I + * `ita-j` - ITA Type J + * `ita-k` - ITA Type K + * `ita-l` - ITA Type L (CEI 23-50) + * `ita-m` - ITA Type M (BS 546) + * `ita-n` - ITA Type N + * `ita-o` - ITA Type O + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `usb-3-b` - USB 3.0 Type B + * `usb-3-micro-b` - USB 3.0 Micro B + * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 + * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 + * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 + * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 + * `dc-terminal` - DC Terminal + * `saf-d-grid` - Saf-D-Grid + * `neutrik-powercon-20` - Neutrik powerCON (20A) + * `neutrik-powercon-32` - Neutrik powerCON (32A) + * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 + * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP + * `ubiquiti-smartpower` - Ubiquiti SmartPower + * `hardwired` - Hardwired + * `other` - Other + x-spec-enum-id: aadcbe6ca854c1ed + nullable: true + maximum_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Maximum power draw (watts) + allocated_draw: + type: integer + maximum: 2147483647 + minimum: 1 + nullable: true + description: Allocated power draw (watts) + description: + type: string + maxLength: 200 + required: + - name + WritablePrefixRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + prefix: + type: string + minLength: 1 + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + status: + enum: + - container + - active + - reserved + - deprecated + type: string + x-spec-enum-id: 026173ce39f2ee63 + description: |- + Operational status of this prefix + + * `container` - Container + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + is_pool: + type: boolean + title: Is a pool + description: All IP addresses within this prefix are considered usable + mark_utilized: + type: boolean + description: Treat as fully utilized + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - prefix + WritableRackRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + facility_id: + type: string + nullable: true + maxLength: 50 + site: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefSiteRequest' + location: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefLocationRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackGroupRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - reserved + - available + - planned + - active + - deprecated + type: string + description: |- + * `reserved` - Reserved + * `available` - Available + * `planned` - Planned + * `active` - Active + * `deprecated` - Deprecated + x-spec-enum-id: 76eea4eef8804bcb + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackRoleRequest' + nullable: true + nullable: true + serial: + type: string + title: Serial number + maxLength: 50 + asset_tag: + type: string + nullable: true + description: A unique tag used to identify this rack + maxLength: 50 + rack_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRackTypeRequest' + nullable: true + nullable: true + form_factor: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + - '' + - null + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + nullable: true + width: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: |- + Rail-to-rail width + + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + minimum: 0 + maximum: 32767 + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + airflow: + enum: + - front-to-rear + - rear-to-front + - '' + - null + type: string + description: |- + * `front-to-rear` - Front to rear + * `rear-to-front` - Rear to front + x-spec-enum-id: a784734d07ef1b3c + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - site + WritableRackReservationRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + rack: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefRackRequest' + units: + type: array + items: + type: integer + maximum: 32767 + minimum: 0 + status: + enum: + - pending + - active + - stale + type: string + description: |- + * `pending` - Pending + * `active` - Active + * `stale` - Stale + x-spec-enum-id: ed6038a4deee151c + user: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefUserRequest' + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + minLength: 1 + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - description + - rack + - units + - user + WritableRackTypeRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + manufacturer: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefManufacturerRequest' + model: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + description: + type: string + maxLength: 200 + form_factor: + enum: + - 2-post-frame + - 4-post-frame + - 4-post-cabinet + - wall-frame + - wall-frame-vertical + - wall-cabinet + - wall-cabinet-vertical + type: string + description: |- + * `2-post-frame` - 2-post frame + * `4-post-frame` - 4-post frame + * `4-post-cabinet` - 4-post cabinet + * `wall-frame` - Wall-mounted frame + * `wall-frame-vertical` - Wall-mounted frame (vertical) + * `wall-cabinet` - Wall-mounted cabinet + * `wall-cabinet-vertical` - Wall-mounted cabinet (vertical) + x-spec-enum-id: 8a902fde21d48841 + width: + enum: + - 10 + - 19 + - 21 + - 23 + type: integer + x-spec-enum-id: 9b322795f297a9c3 + description: |- + Rail-to-rail width + + * `10` - 10 inches + * `19` - 19 inches + * `21` - 21 inches + * `23` - 23 inches + minimum: 0 + maximum: 32767 + u_height: + type: integer + maximum: 100 + minimum: 1 + title: Height (U) + description: Height in rack units + starting_unit: + type: integer + maximum: 32767 + minimum: 1 + description: Starting unit for rack + desc_units: + type: boolean + title: Descending units + description: Units are numbered top-to-bottom + outer_width: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (width) + outer_height: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (height) + outer_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Outer dimension of rack (depth) + outer_unit: + enum: + - mm + - in + - '' + - null + type: string + description: |- + * `mm` - Millimeters + * `in` - Inches + x-spec-enum-id: 3d701848b66312c3 + nullable: true + weight: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + max_weight: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: Maximum load capacity for the rack + weight_unit: + enum: + - kg + - g + - lb + - oz + - '' + - null + type: string + description: |- + * `kg` - Kilograms + * `g` - Grams + * `lb` - Pounds + * `oz` - Ounces + x-spec-enum-id: 2235ce3f404afbc0 + nullable: true + mounting_depth: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + description: Maximum depth of a mounted device, in millimeters. For four-post + racks, this is the distance between the front and rear rails. + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - form_factor + - manufacturer + - model + - slug + WritableRearPortRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + module: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortMappingRequest' + description: + type: string + maxLength: 200 + mark_connected: + type: boolean + description: Treat as if a cable is connected + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - type + WritableRearPortTemplateRequest: + type: object + description: |- + Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during + validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144) + properties: + device_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceTypeRequest' + nullable: true + nullable: true + module_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefModuleTypeRequest' + nullable: true + nullable: true + name: + type: string + minLength: 1 + description: '{module} is accepted as a substitution for the module bay + position when attached to a module type.' + maxLength: 64 + label: + type: string + description: Physical label + maxLength: 64 + type: + enum: + - 8p8c + - 8p6c + - 8p4c + - 8p2c + - 6p6c + - 6p4c + - 6p2c + - 4p4c + - 4p2c + - gg45 + - tera-4p + - tera-2p + - tera-1p + - 110-punch + - bnc + - f + - n + - mrj21 + - fc + - fc-pc + - fc-upc + - fc-apc + - lc + - lc-pc + - lc-upc + - lc-apc + - lsh + - lsh-pc + - lsh-upc + - lsh-apc + - lx5 + - lx5-pc + - lx5-upc + - lx5-apc + - mpo + - mtrj + - sc + - sc-pc + - sc-upc + - sc-apc + - st + - cs + - sn + - sma-905 + - sma-906 + - urm-p2 + - urm-p4 + - urm-p8 + - splice + - usb-a + - usb-b + - usb-c + - usb-mini-a + - usb-mini-b + - usb-micro-a + - usb-micro-b + - usb-micro-ab + - other + type: string + description: |- + * `8p8c` - 8P8C + * `8p6c` - 8P6C + * `8p4c` - 8P4C + * `8p2c` - 8P2C + * `6p6c` - 6P6C + * `6p4c` - 6P4C + * `6p2c` - 6P2C + * `4p4c` - 4P4C + * `4p2c` - 4P2C + * `gg45` - GG45 + * `tera-4p` - TERA 4P + * `tera-2p` - TERA 2P + * `tera-1p` - TERA 1P + * `110-punch` - 110 Punch + * `bnc` - BNC + * `f` - F Connector + * `n` - N Connector + * `mrj21` - MRJ21 + * `fc` - FC + * `fc-pc` - FC/PC + * `fc-upc` - FC/UPC + * `fc-apc` - FC/APC + * `lc` - LC + * `lc-pc` - LC/PC + * `lc-upc` - LC/UPC + * `lc-apc` - LC/APC + * `lsh` - LSH + * `lsh-pc` - LSH/PC + * `lsh-upc` - LSH/UPC + * `lsh-apc` - LSH/APC + * `lx5` - LX.5 + * `lx5-pc` - LX.5/PC + * `lx5-upc` - LX.5/UPC + * `lx5-apc` - LX.5/APC + * `mpo` - MPO + * `mtrj` - MTRJ + * `sc` - SC + * `sc-pc` - SC/PC + * `sc-upc` - SC/UPC + * `sc-apc` - SC/APC + * `st` - ST + * `cs` - CS + * `sn` - SN + * `sma-905` - SMA 905 + * `sma-906` - SMA 906 + * `urm-p2` - URM-P2 + * `urm-p4` - URM-P4 + * `urm-p8` - URM-P8 + * `splice` - Splice + * `usb-a` - USB Type A + * `usb-b` - USB Type B + * `usb-c` - USB Type C + * `usb-mini-a` - USB Mini A + * `usb-mini-b` - USB Mini B + * `usb-micro-a` - USB Micro A + * `usb-micro-b` - USB Micro B + * `usb-micro-ab` - USB Micro AB + * `other` - Other + x-spec-enum-id: 2696b7065f33307c + color: + type: string + pattern: ^[0-9a-f]{6}$ + maxLength: 6 + positions: + type: integer + maximum: 1024 + minimum: 1 + front_ports: + type: array + items: + $ref: '#/components/schemas/RearPortTemplateMappingRequest' + description: + type: string + maxLength: 200 + required: + - name + - type + WritableRegionRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + WritableServiceRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + parent_object_type: + type: string + parent_object_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + name: + type: string + minLength: 1 + maxLength: 100 + protocol: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + ipaddresses: + type: array + items: + type: integer + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - parent_object_id + - parent_object_type + - ports + - protocol + WritableServiceTemplateRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + protocol: + enum: + - tcp + - udp + - sctp + type: string + description: |- + * `tcp` - TCP + * `udp` - UDP + * `sctp` - SCTP + x-spec-enum-id: e4b15bec749a2a32 + ports: + type: array + items: + type: integer + maximum: 65535 + minimum: 1 + title: Port numbers + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - ports + - protocol + WritableSiteGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + WritableSiteRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + description: Full name of the site + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + status: + enum: + - planned + - staging + - active + - decommissioning + - retired + type: string + description: |- + * `planned` - Planned + * `staging` - Staging + * `active` - Active + * `decommissioning` - Decommissioning + * `retired` - Retired + x-spec-enum-id: 1cf60831fbb35e7f + region: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRegionRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteGroupRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + facility: + type: string + description: Local facility ID or description + maxLength: 50 + time_zone: + type: string + nullable: true + minLength: 1 + description: + type: string + maxLength: 200 + physical_address: + type: string + description: Physical location of the building + maxLength: 200 + shipping_address: + type: string + description: If different from the physical address + maxLength: 200 + latitude: + type: number + format: double + maximum: 90.0 + minimum: -90.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + longitude: + type: number + format: double + maximum: 180.0 + minimum: -180.0 + nullable: true + description: GPS coordinate in decimal format (xx.yyyyyy) + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + asns: + type: array + items: + type: integer + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - slug + WritableTenantGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + WritableTunnelRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + status: + enum: + - planned + - active + - disabled + type: string + description: |- + * `planned` - Planned + * `active` - Active + * `disabled` - Disabled + x-spec-enum-id: 2431ef62c418f485 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTunnelGroupRequest' + nullable: true + nullable: true + encapsulation: + enum: + - ipsec-transport + - ipsec-tunnel + - ip-ip + - gre + - wireguard + - openvpn + - l2tp + - pptp + type: string + description: |- + * `ipsec-transport` - IPsec - Transport + * `ipsec-tunnel` - IPsec - Tunnel + * `ip-ip` - IP-in-IP + * `gre` - GRE + * `wireguard` - WireGuard + * `openvpn` - OpenVPN + * `l2tp` - L2TP + * `pptp` - PPTP + x-spec-enum-id: 4f3254459f0e94f0 + ipsec_profile: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPSecProfileRequest' + nullable: true + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + tunnel_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - encapsulation + - name + WritableTunnelTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + tunnel: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefTunnelRequest' + role: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + termination_type: + type: string + termination_id: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + outside_ip: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - termination_type + - tunnel + WritableVLANRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + site: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteRequest' + nullable: true + nullable: true + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANGroupRequest' + nullable: true + nullable: true + vid: + type: integer + maximum: 4094 + minimum: 1 + title: VLAN ID + description: Numeric VLAN ID (1-4094) + name: + type: string + minLength: 1 + maxLength: 64 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - deprecated + type: string + x-spec-enum-id: ca933c38b935e547 + description: |- + Operational status of this VLAN + + * `active` - Active + * `reserved` - Reserved + * `deprecated` - Deprecated + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefRoleRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + qinq_role: + enum: + - svlan + - cvlan + - '' + - null + type: string + x-spec-enum-id: fa0abd59fb1a7312 + nullable: true + title: Q-in-Q role + description: |- + Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) + + * `svlan` - Service + * `cvlan` - Customer + qinq_svlan: + type: integer + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - vid + WritableVMInterfaceRequest: + type: object + description: Adds an `owner` field for models which have a ForeignKey to users.Owner. + properties: + virtual_machine: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualMachineRequest' + name: + type: string + minLength: 1 + maxLength: 64 + enabled: + type: boolean + parent: + type: integer + nullable: true + title: Parent interface + bridge: + type: integer + nullable: true + title: Bridge interface + mtu: + type: integer + maximum: 65536 + minimum: 1 + nullable: true + primary_mac_address: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefMACAddressRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + mode: + enum: + - access + - tagged + - tagged-all + - q-in-q + - '' + - null + type: string + x-spec-enum-id: 84129b71b974ebe5 + nullable: true + description: |- + IEEE 802.1Q tagging strategy + + * `access` - Access + * `tagged` - Tagged + * `tagged-all` - Tagged (All) + * `q-in-q` - Q-in-Q (802.1ad) + untagged_vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + tagged_vlans: + type: array + items: + type: integer + qinq_svlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + vlan_translation_policy: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' + nullable: true + nullable: true + vrf: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVRFRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + - virtual_machine + WritableVirtualChassisRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + domain: + type: string + maxLength: 30 + master: + type: integer + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - name + WritableVirtualCircuitRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + cid: + type: string + minLength: 1 + title: Circuit ID + description: Unique circuit ID + maxLength: 100 + provider_network: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefProviderNetworkRequest' + provider_account: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefProviderAccountRequest' + nullable: true + nullable: true + type: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualCircuitTypeRequest' + status: + enum: + - planned + - provisioning + - active + - offline + - deprovisioning + - decommissioned + type: string + description: |- + * `planned` - Planned + * `provisioning` - Provisioning + * `active` - Active + * `offline` - Offline + * `deprovisioning` - Deprovisioning + * `decommissioned` - Decommissioned + x-spec-enum-id: 0a239d878b6666a4 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - cid + - provider_network + - type + WritableVirtualCircuitTerminationRequest: + type: object + description: Adds support for custom fields and tags. + properties: + virtual_circuit: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefVirtualCircuitRequest' + role: + enum: + - peer + - hub + - spoke + type: string + description: |- + * `peer` - Peer + * `hub` - Hub + * `spoke` - Spoke + x-spec-enum-id: 0b3bfadcebd86b58 + interface: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - interface + - virtual_circuit + WritableVirtualDeviceContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + device: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefDeviceRequest' + identifier: + type: integer + maximum: 32767 + minimum: 0 + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + status: + enum: + - active + - planned + - offline + type: string + description: |- + * `active` - Active + * `planned` - Planned + * `offline` - Offline + x-spec-enum-id: 0e2c0919d51b83cb + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - device + - name + - status + WritableVirtualMachineWithConfigContextRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + name: + type: string + minLength: 1 + maxLength: 64 + virtual_machine_type: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVirtualMachineTypeRequest' + nullable: true + nullable: true + role: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRoleRequest' + nullable: true + nullable: true + status: + enum: + - offline + - active + - planned + - staged + - failed + - decommissioning + - paused + type: string + description: |- + * `offline` - Offline + * `active` - Active + * `planned` - Planned + * `staged` - Staged + * `failed` - Failed + * `decommissioning` - Decommissioning + * `paused` - Paused + x-spec-enum-id: effecc3b94e0b74b + start_on_boot: + enum: + - 'on' + - 'off' + - laststate + type: string + description: |- + * `on` - On + * `off` - Off + * `laststate` - Last State + x-spec-enum-id: 610e33fc2fde73d6 + site: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefSiteRequest' + nullable: true + nullable: true + cluster: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefClusterRequest' + nullable: true + nullable: true + device: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefDeviceRequest' + nullable: true + nullable: true + platform: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefPlatformRequest' + nullable: true + nullable: true + primary_ip4: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + primary_ip6: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefIPAddressRequest' + nullable: true + nullable: true + vcpus: + type: number + format: double + maximum: 10000 + minimum: 0.01000000000000000020816681711721685132943093776702880859375 + exclusiveMaximum: true + nullable: true + memory: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + disk: + type: integer + maximum: 2147483647 + minimum: 0 + nullable: true + description: + type: string + maxLength: 200 + serial: + type: string + title: Serial number + maxLength: 50 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + local_context_data: + nullable: true + description: Local config context data takes precedence over source contexts + in the final rendered config context + config_template: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefConfigTemplateRequest' + nullable: true + nullable: true + custom_fields: + type: object + additionalProperties: {} + required: + - name + WritableWirelessLANGroupRequest: + type: object + description: Base serializer class for models inheriting from NestedGroupModel. + properties: + name: + type: string + minLength: 1 + maxLength: 100 + slug: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[-a-zA-Z0-9_]+$ + parent: + type: integer + nullable: true + description: + type: string + maxLength: 200 + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + required: + - name + - slug + WritableWirelessLANRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + ssid: + type: string + minLength: 1 + maxLength: 32 + description: + type: string + maxLength: 200 + group: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefWirelessLANGroupRequest' + nullable: true + nullable: true + status: + enum: + - active + - reserved + - disabled + - deprecated + type: string + description: |- + * `active` - Active + * `reserved` - Reserved + * `disabled` - Disabled + * `deprecated` - Deprecated + x-spec-enum-id: e5549d7370ce2e6c + vlan: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefVLANRequest' + nullable: true + nullable: true + scope_type: + type: string + nullable: true + scope_id: + type: integer + nullable: true + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + auth_type: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + - null + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + auth_cipher: + enum: + - auto + - tkip + - aes + - '' + - null + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - ssid + WritableWirelessLinkRequest: + type: object + description: Base serializer class for models inheriting from PrimaryModel. + properties: + interface_a: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + interface_b: + oneOf: + - type: integer + - $ref: '#/components/schemas/BriefInterfaceRequest' + ssid: + type: string + maxLength: 32 + status: + enum: + - connected + - planned + - decommissioning + type: string + description: |- + * `connected` - Connected + * `planned` - Planned + * `decommissioning` - Decommissioning + x-spec-enum-id: 80d251a40f3a3144 + tenant: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefTenantRequest' + nullable: true + nullable: true + auth_type: + enum: + - open + - wep + - wpa-personal + - wpa-enterprise + - '' + - null + type: string + description: |- + * `open` - Open + * `wep` - WEP + * `wpa-personal` - WPA Personal (PSK) + * `wpa-enterprise` - WPA Enterprise + x-spec-enum-id: e917c12aac765910 + nullable: true + title: Authentication type + auth_cipher: + enum: + - auto + - tkip + - aes + - '' + - null + type: string + description: |- + * `auto` - Auto + * `tkip` - TKIP + * `aes` - AES + x-spec-enum-id: 42f867e89988bb0c + nullable: true + title: Authentication cipher + auth_psk: + type: string + title: Pre-shared key + maxLength: 64 + distance: + type: number + format: double + maximum: 1000000 + minimum: -1000000 + exclusiveMaximum: true + exclusiveMinimum: true + nullable: true + distance_unit: + enum: + - km + - m + - mi + - ft + - '' + - null + type: string + description: |- + * `km` - Kilometers + * `m` - Meters + * `mi` - Miles + * `ft` - Feet + x-spec-enum-id: b1169a409430c02e + nullable: true + description: + type: string + maxLength: 200 + owner: + oneOf: + - type: integer + - allOf: + - $ref: '#/components/schemas/BriefOwnerRequest' + nullable: true + nullable: true + comments: + type: string + tags: + type: array + items: + $ref: '#/components/schemas/NestedTagRequest' + custom_fields: + type: object + additionalProperties: {} + required: + - interface_a + - interface_b + securitySchemes: + cookieAuth: + type: apiKey + in: cookie + name: sessionid + tokenAuth: + type: apiKey + in: header + name: Authorization + description: '`Token ` (v1) or `Bearer .` (v2)' +servers: +- url: '' + description: NetBox diff --git a/bin/generate.py b/bin/generate.py index 3cba5220..88f0b28a 100644 --- a/bin/generate.py +++ b/bin/generate.py @@ -65,10 +65,12 @@ def sanitize_parameters(parameters): parameter["description"] = parameter_name if parameter.get("schema"): - if parameter["schema"]["type"] == "number": - parameter["type"] = "integer" - else: - parameter["type"] = parameter["schema"]["type"] + param_type = parameter["schema"]["type"] + if param_type == "array": + param_type = parameter["schema"].get("items", {}).get("type", "string") + if param_type == "number": + param_type = "integer" + parameter["type"] = param_type else: if parameter["type"] == "number": parameter["type"] = "integer" @@ -78,6 +80,17 @@ def sanitize_parameters(parameters): return parameters +def resolve_property_type(data): + if "type" in data: + return data["type"] + for key in ("oneOf", "anyOf", "allOf"): + for sub in data.get(key, []): + resolved = resolve_property_type(sub) + if resolved and resolved != "object": + return resolved + return "object" + + def parse_component_properties(properties, required): """ Parse component properties from OpenAPI v3 specification. @@ -90,7 +103,7 @@ def parse_component_properties(properties, required): description = data.get("description", name.replace("_", " ").capitalize()) title = data.get("title", description) - parameter = {"name": name, "type": data.get("type", "object"), "description": title} + parameter = {"name": name, "type": resolve_property_type(data), "description": title} if name in required: parameter["required"] = True @@ -101,6 +114,26 @@ def parse_component_properties(properties, required): return sanitize_parameters(parameters) +def extract_body_ref(schema): + if "$ref" in schema: + return schema["$ref"] + for branch in schema.get("oneOf", []) + schema.get("anyOf", []): + if branch.get("type") == "array": + continue + ref = extract_body_ref(branch) + if ref: + return ref + if "allOf" in schema: + refs = set() + for member in schema["allOf"]: + ref = extract_body_ref(member) + if ref: + refs.add(ref) + if len(refs) == 1: + return refs.pop() + return None + + def get_actions(spec): """ Generate actions from NetBox API schema from OpenAPI v3 specification. @@ -131,16 +164,29 @@ def get_actions(spec): print(f"Processing {action_name} ...") content = method_spec.get("requestBody", {}).get("content", {}) - ref = content.get("application/json", {}).get("schema", {}).get("$ref") + body_schema = content.get("application/json", {}).get("schema", {}) + ref = extract_body_ref(body_schema) if ref: ref_name = ref.split("/")[-1] schema = spec["components"]["schemas"][ref_name] - try: - required = ["id"] if method == "patch" else schema["required"] - except KeyError: - required = [] - action["parameters"] = parse_component_properties(schema["properties"], required) + properties = schema.get("properties") + if properties is None: + print( + f"WARNING: component {ref_name} for {action_name} has no properties, " + f"no body parameters generated" + ) + else: + try: + required = ["id"] if method == "patch" else schema["required"] + except KeyError: + required = [] + action["parameters"] = parse_component_properties(properties, required) + elif content and body_schema.get("type") != "array": + print( + f"WARNING: unresolved request body for {action_name} " + f"(content types: {list(content.keys())}), no body parameters generated" + ) if method == "get": if method_spec["operationId"].endswith("_list"): @@ -182,9 +228,8 @@ def get_actions(spec): for detailed_get in deferred_detail_gets: list_action = actions.get(detailed_get) if list_action is None: - raise Exception( - "Unable to find list action for deferred GET endpoint {}".format(detailed_get) - ) + print(f"WARNING: no list action for deferred GET endpoint {detailed_get}, skipping") + continue return actions diff --git a/pack.yaml b/pack.yaml index ccf60342..a57a6f14 100644 --- a/pack.yaml +++ b/pack.yaml @@ -6,7 +6,7 @@ keywords: - networking - ipam - dcim -version: 3.4.4 +version: 3.4.5 python_versions: - "3" author: John Anderson, Jefferson White