naftiko: 1.0.0-alpha2 info: label: NetBox REST API — virtualization description: 'NetBox REST API — virtualization. 55 operations. Lead operation: virtualization. Self-contained Naftiko capability covering one Netbox business surface.' tags: - Netbox - virtualization created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: NETBOX_API_KEY: NETBOX_API_KEY capability: consumes: - type: http namespace: netbox-virtualization baseUri: '' description: NetBox REST API — virtualization business capability. Self-contained, no shared references. resources: - name: api-virtualization-cluster-groups path: /api/virtualization/cluster-groups/ operations: - name: virtualizationclustergroupslist method: GET description: Get a list of cluster group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: slug in: query type: array - name: slug__empty in: query type: boolean - name: slug__ic in: query type: array - name: slug__ie in: query type: array - name: slug__iew in: query type: array - name: slug__iregex in: query type: array - name: slug__isw in: query type: array - name: slug__n in: query type: array - name: slug__nic in: query type: array - name: slug__nie in: query type: array - name: slug__niew in: query type: array - name: slug__nisw in: query type: array - name: slug__regex in: query type: array - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: virtualizationclustergroupscreate method: POST description: Post a list of cluster group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustergroupsbulkupdate method: PUT description: Put a list of cluster group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustergroupsbulkpartialupdate method: PATCH description: Patch a list of cluster group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustergroupsbulkdestroy method: DELETE description: Delete a list of cluster group objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-virtualization-cluster-groups-id path: /api/virtualization/cluster-groups/{id}/ operations: - name: virtualizationclustergroupsretrieve method: GET description: Get a cluster group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster group. required: true - name: virtualizationclustergroupsupdate method: PUT description: Put a cluster group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster group. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustergroupspartialupdate method: PATCH description: Patch a cluster group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster group. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: virtualizationclustergroupsdestroy method: DELETE description: Delete a cluster group object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster group. required: true - name: api-virtualization-cluster-types path: /api/virtualization/cluster-types/ operations: - name: virtualizationclustertypeslist method: GET description: Get a list of cluster type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: slug in: query type: array - name: slug__empty in: query type: boolean - name: slug__ic in: query type: array - name: slug__ie in: query type: array - name: slug__iew in: query type: array - name: slug__iregex in: query type: array - name: slug__isw in: query type: array - name: slug__n in: query type: array - name: slug__nic in: query type: array - name: slug__nie in: query type: array - name: slug__niew in: query type: array - name: slug__nisw in: query type: array - name: slug__regex in: query type: array - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: virtualizationclustertypescreate method: POST description: Post a list of cluster type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustertypesbulkupdate method: PUT description: Put a list of cluster type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustertypesbulkpartialupdate method: PATCH description: Patch a list of cluster type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustertypesbulkdestroy method: DELETE description: Delete a list of cluster type objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-virtualization-cluster-types-id path: /api/virtualization/cluster-types/{id}/ operations: - name: virtualizationclustertypesretrieve method: GET description: Get a cluster type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster type. required: true - name: virtualizationclustertypesupdate method: PUT description: Put a cluster type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster type. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustertypespartialupdate method: PATCH description: Patch a cluster type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster type. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: virtualizationclustertypesdestroy method: DELETE description: Delete a cluster type object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster type. required: true - name: api-virtualization-clusters path: /api/virtualization/clusters/ operations: - name: virtualizationclusterslist method: GET description: Get a list of cluster objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: group in: query type: array description: Parent group (slug) - name: group__n in: query type: array description: Parent group (slug) - name: group_id in: query type: array description: Parent group (ID) - name: group_id__n in: query type: array description: Parent group (ID) - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: location in: query type: array - name: location__n in: query type: array - name: location_id in: query type: array - name: location_id__n in: query type: array - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: region in: query type: array - name: region__n in: query type: array - name: region_id in: query type: array - name: region_id__n in: query type: array - name: scope_id in: query type: array - name: scope_id__empty in: query type: boolean - name: scope_id__gt in: query type: array - name: scope_id__gte in: query type: array - name: scope_id__lt in: query type: array - name: scope_id__lte in: query type: array - name: scope_id__n in: query type: array - name: scope_type in: query type: array - name: scope_type__n in: query type: array - name: site in: query type: array description: Site (slug) - name: site__n in: query type: array description: Site (slug) - name: site_group in: query type: array - name: site_group__n in: query type: array - name: site_group_id in: query type: array - name: site_group_id__n in: query type: array - name: site_id in: query type: array description: Site (ID) - name: site_id__n in: query type: array description: Site (ID) - name: status in: query type: array - name: status__empty in: query type: boolean - name: status__ic in: query type: array - name: status__ie in: query type: array - name: status__iew in: query type: array - name: status__iregex in: query type: array - name: status__isw in: query type: array - name: status__n in: query type: array - name: status__nic in: query type: array - name: status__nie in: query type: array - name: status__niew in: query type: array - name: status__nisw in: query type: array - name: status__regex in: query type: array - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: tenant in: query type: array description: Tenant (slug) - name: tenant__n in: query type: array description: Tenant (slug) - name: tenant_group in: query type: array - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: type in: query type: array description: Cluster type (slug) - name: type__n in: query type: array description: Cluster type (slug) - name: type_id in: query type: array description: Cluster type (ID) - name: type_id__n in: query type: array description: Cluster type (ID) - name: updated_by_request in: query type: string - name: virtualizationclusterscreate method: POST description: Post a list of cluster objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustersbulkupdate method: PUT description: Put a list of cluster objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustersbulkpartialupdate method: PATCH description: Patch a list of cluster objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclustersbulkdestroy method: DELETE description: Delete a list of cluster objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-virtualization-clusters-id path: /api/virtualization/clusters/{id}/ operations: - name: virtualizationclustersretrieve method: GET description: Get a cluster object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster. required: true - name: virtualizationclustersupdate method: PUT description: Put a cluster object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationclusterspartialupdate method: PATCH description: Patch a cluster object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: virtualizationclustersdestroy method: DELETE description: Delete a cluster object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this cluster. required: true - name: api-virtualization-interfaces path: /api/virtualization/interfaces/ operations: - name: virtualizationinterfaceslist method: GET description: Get a list of interface objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: bridge_id in: query type: array description: Bridged interface (ID) - name: bridge_id__n in: query type: array description: Bridged interface (ID) - name: cluster in: query type: array description: Cluster - name: cluster__n in: query type: array description: Cluster - name: cluster_id in: query type: array description: Cluster (ID) - name: cluster_id__n in: query type: array description: Cluster (ID) - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: enabled in: query type: boolean - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: l2vpn in: query type: array description: L2VPN - name: l2vpn__n in: query type: array description: L2VPN - name: l2vpn_id in: query type: array description: L2VPN (ID) - name: l2vpn_id__n in: query type: array description: L2VPN (ID) - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: mac_address in: query type: array - name: mac_address__ic in: query type: array - name: mac_address__ie in: query type: array - name: mac_address__iew in: query type: array - name: mac_address__iregex in: query type: array - name: mac_address__isw in: query type: array - name: mac_address__n in: query type: array - name: mac_address__nic in: query type: array - name: mac_address__nie in: query type: array - name: mac_address__niew in: query type: array - name: mac_address__nisw in: query type: array - name: mac_address__regex in: query type: array - name: mode in: query type: array description: 802.1Q Mode - name: mode__empty in: query type: boolean description: 802.1Q Mode - name: mode__ic in: query type: array description: 802.1Q Mode - name: mode__ie in: query type: array description: 802.1Q Mode - name: mode__iew in: query type: array description: 802.1Q Mode - name: mode__iregex in: query type: array description: 802.1Q Mode - name: mode__isw in: query type: array description: 802.1Q Mode - name: mode__n in: query type: array description: 802.1Q Mode - name: mode__nic in: query type: array description: 802.1Q Mode - name: mode__nie in: query type: array description: 802.1Q Mode - name: mode__niew in: query type: array description: 802.1Q Mode - name: mode__nisw in: query type: array description: 802.1Q Mode - name: mode__regex in: query type: array description: 802.1Q Mode - name: modified_by_request in: query type: string - name: mtu in: query type: array - name: mtu__empty in: query type: boolean - name: mtu__gt in: query type: array - name: mtu__gte in: query type: array - name: mtu__lt in: query type: array - name: mtu__lte in: query type: array - name: mtu__n in: query type: array - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: parent_id in: query type: array description: Parent interface (ID) - name: parent_id__n in: query type: array description: Parent interface (ID) - name: primary_mac_address in: query type: array description: Primary MAC address - name: primary_mac_address__n in: query type: array description: Primary MAC address - name: primary_mac_address_id in: query type: array description: Primary MAC address (ID) - name: primary_mac_address_id__n in: query type: array description: Primary MAC address (ID) - name: q in: query type: string description: Search - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: virtual_machine in: query type: array description: Virtual machine - name: virtual_machine__n in: query type: array description: Virtual machine - name: virtual_machine_id in: query type: array description: Virtual machine (ID) - name: virtual_machine_id__n in: query type: array description: Virtual machine (ID) - name: vlan in: query type: string description: Assigned VID - name: vlan_id in: query type: string description: Assigned VLAN - name: vlan_translation_policy in: query type: array description: VLAN Translation Policy - name: vlan_translation_policy__n in: query type: array description: VLAN Translation Policy - name: vlan_translation_policy_id in: query type: array description: VLAN Translation Policy (ID) - name: vlan_translation_policy_id__n in: query type: array description: VLAN Translation Policy (ID) - name: vrf in: query type: array description: VRF (RD) - name: vrf__n in: query type: array description: VRF (RD) - name: vrf_id in: query type: array description: VRF - name: vrf_id__n in: query type: array description: VRF - name: virtualizationinterfacescreate method: POST description: Post a list of interface objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationinterfacesbulkupdate method: PUT description: Put a list of interface objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationinterfacesbulkpartialupdate method: PATCH description: Patch a list of interface objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationinterfacesbulkdestroy method: DELETE description: Delete a list of interface objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-virtualization-interfaces-id path: /api/virtualization/interfaces/{id}/ operations: - name: virtualizationinterfacesretrieve method: GET description: Get a interface object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this interface. required: true - name: virtualizationinterfacesupdate method: PUT description: Put a interface object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this interface. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationinterfacespartialupdate method: PATCH description: Patch a interface object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this interface. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: virtualizationinterfacesdestroy method: DELETE description: Delete a interface object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this interface. required: true - name: api-virtualization-virtual-disks path: /api/virtualization/virtual-disks/ operations: - name: virtualizationvirtualdiskslist method: GET description: Get a list of virtual disk objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: q in: query type: string description: Search - name: size in: query type: array - name: size__empty in: query type: boolean - name: size__gt in: query type: array - name: size__gte in: query type: array - name: size__lt in: query type: array - name: size__lte in: query type: array - name: size__n in: query type: array - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: updated_by_request in: query type: string - name: virtual_machine in: query type: array description: Virtual machine - name: virtual_machine__n in: query type: array description: Virtual machine - name: virtual_machine_id in: query type: array description: Virtual machine (ID) - name: virtual_machine_id__n in: query type: array description: Virtual machine (ID) - name: virtualizationvirtualdiskscreate method: POST description: Post a list of virtual disk objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualdisksbulkupdate method: PUT description: Put a list of virtual disk objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualdisksbulkpartialupdate method: PATCH description: Patch a list of virtual disk objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualdisksbulkdestroy method: DELETE description: Delete a list of virtual disk objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-virtualization-virtual-disks-id path: /api/virtualization/virtual-disks/{id}/ operations: - name: virtualizationvirtualdisksretrieve method: GET description: Get a virtual disk object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual disk. required: true - name: virtualizationvirtualdisksupdate method: PUT description: Put a virtual disk object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual disk. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualdiskspartialupdate method: PATCH description: Patch a virtual disk object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual disk. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: virtualizationvirtualdisksdestroy method: DELETE description: Delete a virtual disk object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual disk. required: true - name: api-virtualization-virtual-machines path: /api/virtualization/virtual-machines/ operations: - name: virtualizationvirtualmachineslist method: GET description: Get a list of virtual machine objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: cluster in: query type: array description: Cluster - name: cluster__n in: query type: array description: Cluster - name: cluster_group in: query type: array description: Cluster group (slug) - name: cluster_group__n in: query type: array description: Cluster group (slug) - name: cluster_group_id in: query type: array description: Cluster group (ID) - name: cluster_group_id__n in: query type: array description: Cluster group (ID) - name: cluster_id in: query type: array description: Cluster (ID) - name: cluster_id__n in: query type: array description: Cluster (ID) - name: cluster_type in: query type: array description: Cluster type (slug) - name: cluster_type__n in: query type: array description: Cluster type (slug) - name: cluster_type_id in: query type: array description: Cluster type (ID) - name: cluster_type_id__n in: query type: array description: Cluster type (ID) - name: config_template_id in: query type: array description: Config template (ID) - name: config_template_id__n in: query type: array description: Config template (ID) - name: contact in: query type: array description: Contact - name: contact__n in: query type: array description: Contact - name: contact_group in: query type: array - name: contact_group__n in: query type: array - name: contact_role in: query type: array description: Contact Role - name: contact_role__n in: query type: array description: Contact Role - name: created in: query type: array - name: created__empty in: query type: array - name: created__gt in: query type: array - name: created__gte in: query type: array - name: created__lt in: query type: array - name: created__lte in: query type: array - name: created__n in: query type: array - name: created_by_request in: query type: string - name: description in: query type: array - name: description__empty in: query type: boolean - name: description__ic in: query type: array - name: description__ie in: query type: array - name: description__iew in: query type: array - name: description__iregex in: query type: array - name: description__isw in: query type: array - name: description__n in: query type: array - name: description__nic in: query type: array - name: description__nie in: query type: array - name: description__niew in: query type: array - name: description__nisw in: query type: array - name: description__regex in: query type: array - name: device in: query type: array description: Device - name: device__n in: query type: array description: Device - name: device_id in: query type: array description: Device (ID) - name: device_id__n in: query type: array description: Device (ID) - name: disk in: query type: array - name: disk__empty in: query type: boolean - name: disk__gt in: query type: array - name: disk__gte in: query type: array - name: disk__lt in: query type: array - name: disk__lte in: query type: array - name: disk__n in: query type: array - name: has_primary_ip in: query type: boolean description: Has a primary IP - name: id in: query type: array - name: id__empty in: query type: boolean - name: id__gt in: query type: array - name: id__gte in: query type: array - name: id__lt in: query type: array - name: id__lte in: query type: array - name: id__n in: query type: array - name: interface_count in: query type: array - name: interface_count__empty in: query type: boolean - name: interface_count__gt in: query type: array - name: interface_count__gte in: query type: array - name: interface_count__lt in: query type: array - name: interface_count__lte in: query type: array - name: interface_count__n in: query type: array - name: last_updated in: query type: array - name: last_updated__empty in: query type: array - name: last_updated__gt in: query type: array - name: last_updated__gte in: query type: array - name: last_updated__lt in: query type: array - name: last_updated__lte in: query type: array - name: last_updated__n in: query type: array - name: limit in: query type: integer description: Number of results to return per page. - name: local_context_data in: query type: boolean description: Has local config context data - name: mac_address in: query type: array - name: mac_address__ic in: query type: array - name: mac_address__ie in: query type: array - name: mac_address__iew in: query type: array - name: mac_address__iregex in: query type: array - name: mac_address__isw in: query type: array - name: mac_address__n in: query type: array - name: mac_address__nic in: query type: array - name: mac_address__nie in: query type: array - name: mac_address__niew in: query type: array - name: mac_address__nisw in: query type: array - name: mac_address__regex in: query type: array - name: memory in: query type: array - name: memory__empty in: query type: boolean - name: memory__gt in: query type: array - name: memory__gte in: query type: array - name: memory__lt in: query type: array - name: memory__lte in: query type: array - name: memory__n in: query type: array - name: modified_by_request in: query type: string - name: name in: query type: array - name: name__empty in: query type: boolean - name: name__ic in: query type: array - name: name__ie in: query type: array - name: name__iew in: query type: array - name: name__iregex in: query type: array - name: name__isw in: query type: array - name: name__n in: query type: array - name: name__nic in: query type: array - name: name__nie in: query type: array - name: name__niew in: query type: array - name: name__nisw in: query type: array - name: name__regex in: query type: array - name: offset in: query type: integer description: The initial index from which to return the results. - name: ordering in: query type: string description: Which field to use when ordering the results. - name: owner in: query type: array description: Owner (name) - name: owner__n in: query type: array description: Owner (name) - name: owner_group in: query type: array description: Owner Group (name) - name: owner_group__n in: query type: array description: Owner Group (name) - name: owner_group_id in: query type: array description: Owner Group (ID) - name: owner_group_id__n in: query type: array description: Owner Group (ID) - name: owner_id in: query type: array description: Owner (ID) - name: owner_id__n in: query type: array description: Owner (ID) - name: platform in: query type: array - name: platform__n in: query type: array - name: platform_id in: query type: array - name: platform_id__n in: query type: array - name: primary_ip4 in: query type: array description: Primary IPv4 (address) - name: primary_ip4__n in: query type: array description: Primary IPv4 (address) - name: primary_ip4_id in: query type: array description: Primary IPv4 (ID) - name: primary_ip4_id__n in: query type: array description: Primary IPv4 (ID) - name: primary_ip6 in: query type: array description: Primary IPv6 (address) - name: primary_ip6__n in: query type: array description: Primary IPv6 (address) - name: primary_ip6_id in: query type: array description: Primary IPv6 (ID) - name: primary_ip6_id__n in: query type: array description: Primary IPv6 (ID) - name: q in: query type: string description: Search - name: region in: query type: array - name: region__n in: query type: array - name: region_id in: query type: array - name: region_id__n in: query type: array - name: role in: query type: array - name: role__n in: query type: array - name: role_id in: query type: array - name: role_id__n in: query type: array - name: serial in: query type: array - name: serial__empty in: query type: boolean - name: serial__ic in: query type: array - name: serial__ie in: query type: array - name: serial__iew in: query type: array - name: serial__iregex in: query type: array - name: serial__isw in: query type: array - name: serial__n in: query type: array - name: serial__nic in: query type: array - name: serial__nie in: query type: array - name: serial__niew in: query type: array - name: serial__nisw in: query type: array - name: serial__regex in: query type: array - name: site in: query type: array description: Site (slug) - name: site__n in: query type: array description: Site (slug) - name: site_group in: query type: array - name: site_group__n in: query type: array - name: site_group_id in: query type: array - name: site_group_id__n in: query type: array - name: site_id in: query type: array description: Site (ID) - name: site_id__n in: query type: array description: Site (ID) - name: start_on_boot in: query type: array - name: start_on_boot__empty in: query type: boolean - name: start_on_boot__ic in: query type: array - name: start_on_boot__ie in: query type: array - name: start_on_boot__iew in: query type: array - name: start_on_boot__iregex in: query type: array - name: start_on_boot__isw in: query type: array - name: start_on_boot__n in: query type: array - name: start_on_boot__nic in: query type: array - name: start_on_boot__nie in: query type: array - name: start_on_boot__niew in: query type: array - name: start_on_boot__nisw in: query type: array - name: start_on_boot__regex in: query type: array - name: status in: query type: array - name: status__empty in: query type: boolean - name: status__ic in: query type: array - name: status__ie in: query type: array - name: status__iew in: query type: array - name: status__iregex in: query type: array - name: status__isw in: query type: array - name: status__n in: query type: array - name: status__nic in: query type: array - name: status__nie in: query type: array - name: status__niew in: query type: array - name: status__nisw in: query type: array - name: status__regex in: query type: array - name: tag in: query type: array - name: tag__n in: query type: array - name: tag_id in: query type: array - name: tag_id__n in: query type: array - name: tenant in: query type: array description: Tenant (slug) - name: tenant__n in: query type: array description: Tenant (slug) - name: tenant_group in: query type: array - name: tenant_group__n in: query type: array - name: tenant_group_id in: query type: array - name: tenant_group_id__n in: query type: array - name: tenant_id in: query type: array description: Tenant (ID) - name: tenant_id__n in: query type: array description: Tenant (ID) - name: updated_by_request in: query type: string - name: vcpus in: query type: array - name: vcpus__empty in: query type: boolean - name: vcpus__gt in: query type: array - name: vcpus__gte in: query type: array - name: vcpus__lt in: query type: array - name: vcpus__lte in: query type: array - name: vcpus__n in: query type: array - name: virtual_disk_count in: query type: array - name: virtual_disk_count__empty in: query type: boolean - name: virtual_disk_count__gt in: query type: array - name: virtual_disk_count__gte in: query type: array - name: virtual_disk_count__lt in: query type: array - name: virtual_disk_count__lte in: query type: array - name: virtual_disk_count__n in: query type: array - name: virtualizationvirtualmachinescreate method: POST description: Post a list of virtual machine objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualmachinesbulkupdate method: PUT description: Put a list of virtual machine objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualmachinesbulkpartialupdate method: PATCH description: Patch a list of virtual machine objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualmachinesbulkdestroy method: DELETE description: Delete a list of virtual machine objects. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: api-virtualization-virtual-machines-id path: /api/virtualization/virtual-machines/{id}/ operations: - name: virtualizationvirtualmachinesretrieve method: GET description: Get a virtual machine object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual machine. required: true - name: virtualizationvirtualmachinesupdate method: PUT description: Put a virtual machine object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual machine. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: virtualizationvirtualmachinespartialupdate method: PATCH description: Patch a virtual machine object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual machine. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: virtualizationvirtualmachinesdestroy method: DELETE description: Delete a virtual machine object. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: A unique integer value identifying this virtual machine. required: true - name: api-virtualization-virtual-machines-id-render-config path: /api/virtualization/virtual-machines/{id}/render-config/ operations: - name: virtualizationvirtualmachinesrenderconfigcreate method: POST description: Resolve and render the preferred ConfigTemplate for this Device or Virtual Machine. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this virtual machine. required: true - name: body in: body type: object description: Request body (JSON). required: true authentication: type: apikey key: sessionid value: '{{env.NETBOX_API_KEY}}' placement: cookie exposes: - type: rest namespace: netbox-virtualization-rest port: 8080 description: REST adapter for NetBox REST API — virtualization. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/api/virtualization/cluster-groups name: api-virtualization-cluster-groups description: REST surface for api-virtualization-cluster-groups. operations: - method: GET name: virtualizationclustergroupslist description: Get a list of cluster group objects. call: netbox-virtualization.virtualizationclustergroupslist with: contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: virtualizationclustergroupscreate description: Post a list of cluster group objects. call: netbox-virtualization.virtualizationclustergroupscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: virtualizationclustergroupsbulkupdate description: Put a list of cluster group objects. call: netbox-virtualization.virtualizationclustergroupsbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationclustergroupsbulkpartialupdate description: Patch a list of cluster group objects. call: netbox-virtualization.virtualizationclustergroupsbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationclustergroupsbulkdestroy description: Delete a list of cluster group objects. call: netbox-virtualization.virtualizationclustergroupsbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/cluster-groups/{id} name: api-virtualization-cluster-groups-id description: REST surface for api-virtualization-cluster-groups-id. operations: - method: GET name: virtualizationclustergroupsretrieve description: Get a cluster group object. call: netbox-virtualization.virtualizationclustergroupsretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: virtualizationclustergroupsupdate description: Put a cluster group object. call: netbox-virtualization.virtualizationclustergroupsupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationclustergroupspartialupdate description: Patch a cluster group object. call: netbox-virtualization.virtualizationclustergroupspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationclustergroupsdestroy description: Delete a cluster group object. call: netbox-virtualization.virtualizationclustergroupsdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/cluster-types name: api-virtualization-cluster-types description: REST surface for api-virtualization-cluster-types. operations: - method: GET name: virtualizationclustertypeslist description: Get a list of cluster type objects. call: netbox-virtualization.virtualizationclustertypeslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q slug: rest.slug slug__empty: rest.slug__empty slug__ic: rest.slug__ic slug__ie: rest.slug__ie slug__iew: rest.slug__iew slug__iregex: rest.slug__iregex slug__isw: rest.slug__isw slug__n: rest.slug__n slug__nic: rest.slug__nic slug__nie: rest.slug__nie slug__niew: rest.slug__niew slug__nisw: rest.slug__nisw slug__regex: rest.slug__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: virtualizationclustertypescreate description: Post a list of cluster type objects. call: netbox-virtualization.virtualizationclustertypescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: virtualizationclustertypesbulkupdate description: Put a list of cluster type objects. call: netbox-virtualization.virtualizationclustertypesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationclustertypesbulkpartialupdate description: Patch a list of cluster type objects. call: netbox-virtualization.virtualizationclustertypesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationclustertypesbulkdestroy description: Delete a list of cluster type objects. call: netbox-virtualization.virtualizationclustertypesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/cluster-types/{id} name: api-virtualization-cluster-types-id description: REST surface for api-virtualization-cluster-types-id. operations: - method: GET name: virtualizationclustertypesretrieve description: Get a cluster type object. call: netbox-virtualization.virtualizationclustertypesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: virtualizationclustertypesupdate description: Put a cluster type object. call: netbox-virtualization.virtualizationclustertypesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationclustertypespartialupdate description: Patch a cluster type object. call: netbox-virtualization.virtualizationclustertypespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationclustertypesdestroy description: Delete a cluster type object. call: netbox-virtualization.virtualizationclustertypesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/clusters name: api-virtualization-clusters description: REST surface for api-virtualization-clusters. operations: - method: GET name: virtualizationclusterslist description: Get a list of cluster objects. call: netbox-virtualization.virtualizationclusterslist with: contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex group: rest.group group__n: rest.group__n group_id: rest.group_id group_id__n: rest.group_id__n id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit location: rest.location location__n: rest.location__n location_id: rest.location_id location_id__n: rest.location_id__n modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n scope_id: rest.scope_id scope_id__empty: rest.scope_id__empty scope_id__gt: rest.scope_id__gt scope_id__gte: rest.scope_id__gte scope_id__lt: rest.scope_id__lt scope_id__lte: rest.scope_id__lte scope_id__n: rest.scope_id__n scope_type: rest.scope_type scope_type__n: rest.scope_type__n site: rest.site site__n: rest.site__n site_group: rest.site_group site_group__n: rest.site_group__n site_group_id: rest.site_group_id site_group_id__n: rest.site_group_id__n site_id: rest.site_id site_id__n: rest.site_id__n status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n tenant: rest.tenant tenant__n: rest.tenant__n tenant_group: rest.tenant_group tenant_group__n: rest.tenant_group__n tenant_group_id: rest.tenant_group_id tenant_group_id__n: rest.tenant_group_id__n tenant_id: rest.tenant_id tenant_id__n: rest.tenant_id__n type: rest.type type__n: rest.type__n type_id: rest.type_id type_id__n: rest.type_id__n updated_by_request: rest.updated_by_request outputParameters: - type: object mapping: $. - method: POST name: virtualizationclusterscreate description: Post a list of cluster objects. call: netbox-virtualization.virtualizationclusterscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: virtualizationclustersbulkupdate description: Put a list of cluster objects. call: netbox-virtualization.virtualizationclustersbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationclustersbulkpartialupdate description: Patch a list of cluster objects. call: netbox-virtualization.virtualizationclustersbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationclustersbulkdestroy description: Delete a list of cluster objects. call: netbox-virtualization.virtualizationclustersbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/clusters/{id} name: api-virtualization-clusters-id description: REST surface for api-virtualization-clusters-id. operations: - method: GET name: virtualizationclustersretrieve description: Get a cluster object. call: netbox-virtualization.virtualizationclustersretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: virtualizationclustersupdate description: Put a cluster object. call: netbox-virtualization.virtualizationclustersupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationclusterspartialupdate description: Patch a cluster object. call: netbox-virtualization.virtualizationclusterspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationclustersdestroy description: Delete a cluster object. call: netbox-virtualization.virtualizationclustersdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/interfaces name: api-virtualization-interfaces description: REST surface for api-virtualization-interfaces. operations: - method: GET name: virtualizationinterfaceslist description: Get a list of interface objects. call: netbox-virtualization.virtualizationinterfaceslist with: bridge_id: rest.bridge_id bridge_id__n: rest.bridge_id__n cluster: rest.cluster cluster__n: rest.cluster__n cluster_id: rest.cluster_id cluster_id__n: rest.cluster_id__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex enabled: rest.enabled id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n l2vpn: rest.l2vpn l2vpn__n: rest.l2vpn__n l2vpn_id: rest.l2vpn_id l2vpn_id__n: rest.l2vpn_id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit mac_address: rest.mac_address mac_address__ic: rest.mac_address__ic mac_address__ie: rest.mac_address__ie mac_address__iew: rest.mac_address__iew mac_address__iregex: rest.mac_address__iregex mac_address__isw: rest.mac_address__isw mac_address__n: rest.mac_address__n mac_address__nic: rest.mac_address__nic mac_address__nie: rest.mac_address__nie mac_address__niew: rest.mac_address__niew mac_address__nisw: rest.mac_address__nisw mac_address__regex: rest.mac_address__regex mode: rest.mode mode__empty: rest.mode__empty mode__ic: rest.mode__ic mode__ie: rest.mode__ie mode__iew: rest.mode__iew mode__iregex: rest.mode__iregex mode__isw: rest.mode__isw mode__n: rest.mode__n mode__nic: rest.mode__nic mode__nie: rest.mode__nie mode__niew: rest.mode__niew mode__nisw: rest.mode__nisw mode__regex: rest.mode__regex modified_by_request: rest.modified_by_request mtu: rest.mtu mtu__empty: rest.mtu__empty mtu__gt: rest.mtu__gt mtu__gte: rest.mtu__gte mtu__lt: rest.mtu__lt mtu__lte: rest.mtu__lte mtu__n: rest.mtu__n name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n parent_id: rest.parent_id parent_id__n: rest.parent_id__n primary_mac_address: rest.primary_mac_address primary_mac_address__n: rest.primary_mac_address__n primary_mac_address_id: rest.primary_mac_address_id primary_mac_address_id__n: rest.primary_mac_address_id__n q: rest.q tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request virtual_machine: rest.virtual_machine virtual_machine__n: rest.virtual_machine__n virtual_machine_id: rest.virtual_machine_id virtual_machine_id__n: rest.virtual_machine_id__n vlan: rest.vlan vlan_id: rest.vlan_id vlan_translation_policy: rest.vlan_translation_policy vlan_translation_policy__n: rest.vlan_translation_policy__n vlan_translation_policy_id: rest.vlan_translation_policy_id vlan_translation_policy_id__n: rest.vlan_translation_policy_id__n vrf: rest.vrf vrf__n: rest.vrf__n vrf_id: rest.vrf_id vrf_id__n: rest.vrf_id__n outputParameters: - type: object mapping: $. - method: POST name: virtualizationinterfacescreate description: Post a list of interface objects. call: netbox-virtualization.virtualizationinterfacescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: virtualizationinterfacesbulkupdate description: Put a list of interface objects. call: netbox-virtualization.virtualizationinterfacesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationinterfacesbulkpartialupdate description: Patch a list of interface objects. call: netbox-virtualization.virtualizationinterfacesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationinterfacesbulkdestroy description: Delete a list of interface objects. call: netbox-virtualization.virtualizationinterfacesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/interfaces/{id} name: api-virtualization-interfaces-id description: REST surface for api-virtualization-interfaces-id. operations: - method: GET name: virtualizationinterfacesretrieve description: Get a interface object. call: netbox-virtualization.virtualizationinterfacesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: virtualizationinterfacesupdate description: Put a interface object. call: netbox-virtualization.virtualizationinterfacesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationinterfacespartialupdate description: Patch a interface object. call: netbox-virtualization.virtualizationinterfacespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationinterfacesdestroy description: Delete a interface object. call: netbox-virtualization.virtualizationinterfacesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/virtual-disks name: api-virtualization-virtual-disks description: REST surface for api-virtualization-virtual-disks. operations: - method: GET name: virtualizationvirtualdiskslist description: Get a list of virtual disk objects. call: netbox-virtualization.virtualizationvirtualdiskslist with: created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n q: rest.q size: rest.size size__empty: rest.size__empty size__gt: rest.size__gt size__gte: rest.size__gte size__lt: rest.size__lt size__lte: rest.size__lte size__n: rest.size__n tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n updated_by_request: rest.updated_by_request virtual_machine: rest.virtual_machine virtual_machine__n: rest.virtual_machine__n virtual_machine_id: rest.virtual_machine_id virtual_machine_id__n: rest.virtual_machine_id__n outputParameters: - type: object mapping: $. - method: POST name: virtualizationvirtualdiskscreate description: Post a list of virtual disk objects. call: netbox-virtualization.virtualizationvirtualdiskscreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: virtualizationvirtualdisksbulkupdate description: Put a list of virtual disk objects. call: netbox-virtualization.virtualizationvirtualdisksbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationvirtualdisksbulkpartialupdate description: Patch a list of virtual disk objects. call: netbox-virtualization.virtualizationvirtualdisksbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationvirtualdisksbulkdestroy description: Delete a list of virtual disk objects. call: netbox-virtualization.virtualizationvirtualdisksbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/virtual-disks/{id} name: api-virtualization-virtual-disks-id description: REST surface for api-virtualization-virtual-disks-id. operations: - method: GET name: virtualizationvirtualdisksretrieve description: Get a virtual disk object. call: netbox-virtualization.virtualizationvirtualdisksretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: virtualizationvirtualdisksupdate description: Put a virtual disk object. call: netbox-virtualization.virtualizationvirtualdisksupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationvirtualdiskspartialupdate description: Patch a virtual disk object. call: netbox-virtualization.virtualizationvirtualdiskspartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationvirtualdisksdestroy description: Delete a virtual disk object. call: netbox-virtualization.virtualizationvirtualdisksdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/virtual-machines name: api-virtualization-virtual-machines description: REST surface for api-virtualization-virtual-machines. operations: - method: GET name: virtualizationvirtualmachineslist description: Get a list of virtual machine objects. call: netbox-virtualization.virtualizationvirtualmachineslist with: cluster: rest.cluster cluster__n: rest.cluster__n cluster_group: rest.cluster_group cluster_group__n: rest.cluster_group__n cluster_group_id: rest.cluster_group_id cluster_group_id__n: rest.cluster_group_id__n cluster_id: rest.cluster_id cluster_id__n: rest.cluster_id__n cluster_type: rest.cluster_type cluster_type__n: rest.cluster_type__n cluster_type_id: rest.cluster_type_id cluster_type_id__n: rest.cluster_type_id__n config_template_id: rest.config_template_id config_template_id__n: rest.config_template_id__n contact: rest.contact contact__n: rest.contact__n contact_group: rest.contact_group contact_group__n: rest.contact_group__n contact_role: rest.contact_role contact_role__n: rest.contact_role__n created: rest.created created__empty: rest.created__empty created__gt: rest.created__gt created__gte: rest.created__gte created__lt: rest.created__lt created__lte: rest.created__lte created__n: rest.created__n created_by_request: rest.created_by_request description: rest.description description__empty: rest.description__empty description__ic: rest.description__ic description__ie: rest.description__ie description__iew: rest.description__iew description__iregex: rest.description__iregex description__isw: rest.description__isw description__n: rest.description__n description__nic: rest.description__nic description__nie: rest.description__nie description__niew: rest.description__niew description__nisw: rest.description__nisw description__regex: rest.description__regex device: rest.device device__n: rest.device__n device_id: rest.device_id device_id__n: rest.device_id__n disk: rest.disk disk__empty: rest.disk__empty disk__gt: rest.disk__gt disk__gte: rest.disk__gte disk__lt: rest.disk__lt disk__lte: rest.disk__lte disk__n: rest.disk__n has_primary_ip: rest.has_primary_ip id: rest.id id__empty: rest.id__empty id__gt: rest.id__gt id__gte: rest.id__gte id__lt: rest.id__lt id__lte: rest.id__lte id__n: rest.id__n interface_count: rest.interface_count interface_count__empty: rest.interface_count__empty interface_count__gt: rest.interface_count__gt interface_count__gte: rest.interface_count__gte interface_count__lt: rest.interface_count__lt interface_count__lte: rest.interface_count__lte interface_count__n: rest.interface_count__n last_updated: rest.last_updated last_updated__empty: rest.last_updated__empty last_updated__gt: rest.last_updated__gt last_updated__gte: rest.last_updated__gte last_updated__lt: rest.last_updated__lt last_updated__lte: rest.last_updated__lte last_updated__n: rest.last_updated__n limit: rest.limit local_context_data: rest.local_context_data mac_address: rest.mac_address mac_address__ic: rest.mac_address__ic mac_address__ie: rest.mac_address__ie mac_address__iew: rest.mac_address__iew mac_address__iregex: rest.mac_address__iregex mac_address__isw: rest.mac_address__isw mac_address__n: rest.mac_address__n mac_address__nic: rest.mac_address__nic mac_address__nie: rest.mac_address__nie mac_address__niew: rest.mac_address__niew mac_address__nisw: rest.mac_address__nisw mac_address__regex: rest.mac_address__regex memory: rest.memory memory__empty: rest.memory__empty memory__gt: rest.memory__gt memory__gte: rest.memory__gte memory__lt: rest.memory__lt memory__lte: rest.memory__lte memory__n: rest.memory__n modified_by_request: rest.modified_by_request name: rest.name name__empty: rest.name__empty name__ic: rest.name__ic name__ie: rest.name__ie name__iew: rest.name__iew name__iregex: rest.name__iregex name__isw: rest.name__isw name__n: rest.name__n name__nic: rest.name__nic name__nie: rest.name__nie name__niew: rest.name__niew name__nisw: rest.name__nisw name__regex: rest.name__regex offset: rest.offset ordering: rest.ordering owner: rest.owner owner__n: rest.owner__n owner_group: rest.owner_group owner_group__n: rest.owner_group__n owner_group_id: rest.owner_group_id owner_group_id__n: rest.owner_group_id__n owner_id: rest.owner_id owner_id__n: rest.owner_id__n platform: rest.platform platform__n: rest.platform__n platform_id: rest.platform_id platform_id__n: rest.platform_id__n primary_ip4: rest.primary_ip4 primary_ip4__n: rest.primary_ip4__n primary_ip4_id: rest.primary_ip4_id primary_ip4_id__n: rest.primary_ip4_id__n primary_ip6: rest.primary_ip6 primary_ip6__n: rest.primary_ip6__n primary_ip6_id: rest.primary_ip6_id primary_ip6_id__n: rest.primary_ip6_id__n q: rest.q region: rest.region region__n: rest.region__n region_id: rest.region_id region_id__n: rest.region_id__n role: rest.role role__n: rest.role__n role_id: rest.role_id role_id__n: rest.role_id__n serial: rest.serial serial__empty: rest.serial__empty serial__ic: rest.serial__ic serial__ie: rest.serial__ie serial__iew: rest.serial__iew serial__iregex: rest.serial__iregex serial__isw: rest.serial__isw serial__n: rest.serial__n serial__nic: rest.serial__nic serial__nie: rest.serial__nie serial__niew: rest.serial__niew serial__nisw: rest.serial__nisw serial__regex: rest.serial__regex site: rest.site site__n: rest.site__n site_group: rest.site_group site_group__n: rest.site_group__n site_group_id: rest.site_group_id site_group_id__n: rest.site_group_id__n site_id: rest.site_id site_id__n: rest.site_id__n start_on_boot: rest.start_on_boot start_on_boot__empty: rest.start_on_boot__empty start_on_boot__ic: rest.start_on_boot__ic start_on_boot__ie: rest.start_on_boot__ie start_on_boot__iew: rest.start_on_boot__iew start_on_boot__iregex: rest.start_on_boot__iregex start_on_boot__isw: rest.start_on_boot__isw start_on_boot__n: rest.start_on_boot__n start_on_boot__nic: rest.start_on_boot__nic start_on_boot__nie: rest.start_on_boot__nie start_on_boot__niew: rest.start_on_boot__niew start_on_boot__nisw: rest.start_on_boot__nisw start_on_boot__regex: rest.start_on_boot__regex status: rest.status status__empty: rest.status__empty status__ic: rest.status__ic status__ie: rest.status__ie status__iew: rest.status__iew status__iregex: rest.status__iregex status__isw: rest.status__isw status__n: rest.status__n status__nic: rest.status__nic status__nie: rest.status__nie status__niew: rest.status__niew status__nisw: rest.status__nisw status__regex: rest.status__regex tag: rest.tag tag__n: rest.tag__n tag_id: rest.tag_id tag_id__n: rest.tag_id__n tenant: rest.tenant tenant__n: rest.tenant__n tenant_group: rest.tenant_group tenant_group__n: rest.tenant_group__n tenant_group_id: rest.tenant_group_id tenant_group_id__n: rest.tenant_group_id__n tenant_id: rest.tenant_id tenant_id__n: rest.tenant_id__n updated_by_request: rest.updated_by_request vcpus: rest.vcpus vcpus__empty: rest.vcpus__empty vcpus__gt: rest.vcpus__gt vcpus__gte: rest.vcpus__gte vcpus__lt: rest.vcpus__lt vcpus__lte: rest.vcpus__lte vcpus__n: rest.vcpus__n virtual_disk_count: rest.virtual_disk_count virtual_disk_count__empty: rest.virtual_disk_count__empty virtual_disk_count__gt: rest.virtual_disk_count__gt virtual_disk_count__gte: rest.virtual_disk_count__gte virtual_disk_count__lt: rest.virtual_disk_count__lt virtual_disk_count__lte: rest.virtual_disk_count__lte virtual_disk_count__n: rest.virtual_disk_count__n outputParameters: - type: object mapping: $. - method: POST name: virtualizationvirtualmachinescreate description: Post a list of virtual machine objects. call: netbox-virtualization.virtualizationvirtualmachinescreate with: body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: virtualizationvirtualmachinesbulkupdate description: Put a list of virtual machine objects. call: netbox-virtualization.virtualizationvirtualmachinesbulkupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationvirtualmachinesbulkpartialupdate description: Patch a list of virtual machine objects. call: netbox-virtualization.virtualizationvirtualmachinesbulkpartialupdate with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationvirtualmachinesbulkdestroy description: Delete a list of virtual machine objects. call: netbox-virtualization.virtualizationvirtualmachinesbulkdestroy with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/virtual-machines/{id} name: api-virtualization-virtual-machines-id description: REST surface for api-virtualization-virtual-machines-id. operations: - method: GET name: virtualizationvirtualmachinesretrieve description: Get a virtual machine object. call: netbox-virtualization.virtualizationvirtualmachinesretrieve with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: virtualizationvirtualmachinesupdate description: Put a virtual machine object. call: netbox-virtualization.virtualizationvirtualmachinesupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: virtualizationvirtualmachinespartialupdate description: Patch a virtual machine object. call: netbox-virtualization.virtualizationvirtualmachinespartialupdate with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: virtualizationvirtualmachinesdestroy description: Delete a virtual machine object. call: netbox-virtualization.virtualizationvirtualmachinesdestroy with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/virtualization/virtual-machines/{id}/render-config name: api-virtualization-virtual-machines-id-render-config description: REST surface for api-virtualization-virtual-machines-id-render-config. operations: - method: POST name: virtualizationvirtualmachinesrenderconfigcreate description: Resolve and render the preferred ConfigTemplate for this Device or Virtual Machine. call: netbox-virtualization.virtualizationvirtualmachinesrenderconfigcreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - type: mcp namespace: netbox-virtualization-mcp port: 9090 transport: http description: MCP adapter for NetBox REST API — virtualization. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: get-list-cluster-group-objects description: Get a list of cluster group objects. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationclustergroupslist with: contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-cluster-group-objects description: Post a list of cluster group objects. hints: readOnly: true destructive: false idempotent: false call: netbox-virtualization.virtualizationclustergroupscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-cluster-group-objects description: Put a list of cluster group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustergroupsbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-cluster-group-objects description: Patch a list of cluster group objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustergroupsbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-cluster-group-objects description: Delete a list of cluster group objects. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationclustergroupsbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-cluster-group-object description: Get a cluster group object. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationclustergroupsretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-cluster-group-object description: Put a cluster group object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustergroupsupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-cluster-group-object description: Patch a cluster group object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustergroupspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-cluster-group-object description: Delete a cluster group object. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationclustergroupsdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-cluster-type-objects description: Get a list of cluster type objects. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationclustertypeslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q slug: tools.slug slug__empty: tools.slug__empty slug__ic: tools.slug__ic slug__ie: tools.slug__ie slug__iew: tools.slug__iew slug__iregex: tools.slug__iregex slug__isw: tools.slug__isw slug__n: tools.slug__n slug__nic: tools.slug__nic slug__nie: tools.slug__nie slug__niew: tools.slug__niew slug__nisw: tools.slug__nisw slug__regex: tools.slug__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-cluster-type-objects description: Post a list of cluster type objects. hints: readOnly: true destructive: false idempotent: false call: netbox-virtualization.virtualizationclustertypescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-cluster-type-objects description: Put a list of cluster type objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustertypesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-cluster-type-objects description: Patch a list of cluster type objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustertypesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-cluster-type-objects description: Delete a list of cluster type objects. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationclustertypesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-cluster-type-object description: Get a cluster type object. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationclustertypesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-cluster-type-object description: Put a cluster type object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustertypesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-cluster-type-object description: Patch a cluster type object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustertypespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-cluster-type-object description: Delete a cluster type object. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationclustertypesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-cluster-objects description: Get a list of cluster objects. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationclusterslist with: contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex group: tools.group group__n: tools.group__n group_id: tools.group_id group_id__n: tools.group_id__n id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit location: tools.location location__n: tools.location__n location_id: tools.location_id location_id__n: tools.location_id__n modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n scope_id: tools.scope_id scope_id__empty: tools.scope_id__empty scope_id__gt: tools.scope_id__gt scope_id__gte: tools.scope_id__gte scope_id__lt: tools.scope_id__lt scope_id__lte: tools.scope_id__lte scope_id__n: tools.scope_id__n scope_type: tools.scope_type scope_type__n: tools.scope_type__n site: tools.site site__n: tools.site__n site_group: tools.site_group site_group__n: tools.site_group__n site_group_id: tools.site_group_id site_group_id__n: tools.site_group_id__n site_id: tools.site_id site_id__n: tools.site_id__n status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n tenant: tools.tenant tenant__n: tools.tenant__n tenant_group: tools.tenant_group tenant_group__n: tools.tenant_group__n tenant_group_id: tools.tenant_group_id tenant_group_id__n: tools.tenant_group_id__n tenant_id: tools.tenant_id tenant_id__n: tools.tenant_id__n type: tools.type type__n: tools.type__n type_id: tools.type_id type_id__n: tools.type_id__n updated_by_request: tools.updated_by_request outputParameters: - type: object mapping: $. - name: post-list-cluster-objects description: Post a list of cluster objects. hints: readOnly: true destructive: false idempotent: false call: netbox-virtualization.virtualizationclusterscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-cluster-objects description: Put a list of cluster objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustersbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-cluster-objects description: Patch a list of cluster objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustersbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-cluster-objects description: Delete a list of cluster objects. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationclustersbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-cluster-object description: Get a cluster object. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationclustersretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-cluster-object description: Put a cluster object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclustersupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-cluster-object description: Patch a cluster object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationclusterspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-cluster-object description: Delete a cluster object. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationclustersdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-interface-objects description: Get a list of interface objects. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationinterfaceslist with: bridge_id: tools.bridge_id bridge_id__n: tools.bridge_id__n cluster: tools.cluster cluster__n: tools.cluster__n cluster_id: tools.cluster_id cluster_id__n: tools.cluster_id__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex enabled: tools.enabled id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n l2vpn: tools.l2vpn l2vpn__n: tools.l2vpn__n l2vpn_id: tools.l2vpn_id l2vpn_id__n: tools.l2vpn_id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit mac_address: tools.mac_address mac_address__ic: tools.mac_address__ic mac_address__ie: tools.mac_address__ie mac_address__iew: tools.mac_address__iew mac_address__iregex: tools.mac_address__iregex mac_address__isw: tools.mac_address__isw mac_address__n: tools.mac_address__n mac_address__nic: tools.mac_address__nic mac_address__nie: tools.mac_address__nie mac_address__niew: tools.mac_address__niew mac_address__nisw: tools.mac_address__nisw mac_address__regex: tools.mac_address__regex mode: tools.mode mode__empty: tools.mode__empty mode__ic: tools.mode__ic mode__ie: tools.mode__ie mode__iew: tools.mode__iew mode__iregex: tools.mode__iregex mode__isw: tools.mode__isw mode__n: tools.mode__n mode__nic: tools.mode__nic mode__nie: tools.mode__nie mode__niew: tools.mode__niew mode__nisw: tools.mode__nisw mode__regex: tools.mode__regex modified_by_request: tools.modified_by_request mtu: tools.mtu mtu__empty: tools.mtu__empty mtu__gt: tools.mtu__gt mtu__gte: tools.mtu__gte mtu__lt: tools.mtu__lt mtu__lte: tools.mtu__lte mtu__n: tools.mtu__n name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n parent_id: tools.parent_id parent_id__n: tools.parent_id__n primary_mac_address: tools.primary_mac_address primary_mac_address__n: tools.primary_mac_address__n primary_mac_address_id: tools.primary_mac_address_id primary_mac_address_id__n: tools.primary_mac_address_id__n q: tools.q tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request virtual_machine: tools.virtual_machine virtual_machine__n: tools.virtual_machine__n virtual_machine_id: tools.virtual_machine_id virtual_machine_id__n: tools.virtual_machine_id__n vlan: tools.vlan vlan_id: tools.vlan_id vlan_translation_policy: tools.vlan_translation_policy vlan_translation_policy__n: tools.vlan_translation_policy__n vlan_translation_policy_id: tools.vlan_translation_policy_id vlan_translation_policy_id__n: tools.vlan_translation_policy_id__n vrf: tools.vrf vrf__n: tools.vrf__n vrf_id: tools.vrf_id vrf_id__n: tools.vrf_id__n outputParameters: - type: object mapping: $. - name: post-list-interface-objects description: Post a list of interface objects. hints: readOnly: true destructive: false idempotent: false call: netbox-virtualization.virtualizationinterfacescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-interface-objects description: Put a list of interface objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationinterfacesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-interface-objects description: Patch a list of interface objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationinterfacesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-interface-objects description: Delete a list of interface objects. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationinterfacesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-interface-object description: Get a interface object. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationinterfacesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-interface-object description: Put a interface object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationinterfacesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-interface-object description: Patch a interface object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationinterfacespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-interface-object description: Delete a interface object. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationinterfacesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-virtual-disk-objects description: Get a list of virtual disk objects. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualdiskslist with: created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n q: tools.q size: tools.size size__empty: tools.size__empty size__gt: tools.size__gt size__gte: tools.size__gte size__lt: tools.size__lt size__lte: tools.size__lte size__n: tools.size__n tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n updated_by_request: tools.updated_by_request virtual_machine: tools.virtual_machine virtual_machine__n: tools.virtual_machine__n virtual_machine_id: tools.virtual_machine_id virtual_machine_id__n: tools.virtual_machine_id__n outputParameters: - type: object mapping: $. - name: post-list-virtual-disk-objects description: Post a list of virtual disk objects. hints: readOnly: true destructive: false idempotent: false call: netbox-virtualization.virtualizationvirtualdiskscreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-virtual-disk-objects description: Put a list of virtual disk objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualdisksbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-virtual-disk-objects description: Patch a list of virtual disk objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualdisksbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-virtual-disk-objects description: Delete a list of virtual disk objects. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationvirtualdisksbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-virtual-disk-object description: Get a virtual disk object. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualdisksretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-virtual-disk-object description: Put a virtual disk object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualdisksupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-virtual-disk-object description: Patch a virtual disk object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualdiskspartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-virtual-disk-object description: Delete a virtual disk object. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationvirtualdisksdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-virtual-machine-objects description: Get a list of virtual machine objects. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualmachineslist with: cluster: tools.cluster cluster__n: tools.cluster__n cluster_group: tools.cluster_group cluster_group__n: tools.cluster_group__n cluster_group_id: tools.cluster_group_id cluster_group_id__n: tools.cluster_group_id__n cluster_id: tools.cluster_id cluster_id__n: tools.cluster_id__n cluster_type: tools.cluster_type cluster_type__n: tools.cluster_type__n cluster_type_id: tools.cluster_type_id cluster_type_id__n: tools.cluster_type_id__n config_template_id: tools.config_template_id config_template_id__n: tools.config_template_id__n contact: tools.contact contact__n: tools.contact__n contact_group: tools.contact_group contact_group__n: tools.contact_group__n contact_role: tools.contact_role contact_role__n: tools.contact_role__n created: tools.created created__empty: tools.created__empty created__gt: tools.created__gt created__gte: tools.created__gte created__lt: tools.created__lt created__lte: tools.created__lte created__n: tools.created__n created_by_request: tools.created_by_request description: tools.description description__empty: tools.description__empty description__ic: tools.description__ic description__ie: tools.description__ie description__iew: tools.description__iew description__iregex: tools.description__iregex description__isw: tools.description__isw description__n: tools.description__n description__nic: tools.description__nic description__nie: tools.description__nie description__niew: tools.description__niew description__nisw: tools.description__nisw description__regex: tools.description__regex device: tools.device device__n: tools.device__n device_id: tools.device_id device_id__n: tools.device_id__n disk: tools.disk disk__empty: tools.disk__empty disk__gt: tools.disk__gt disk__gte: tools.disk__gte disk__lt: tools.disk__lt disk__lte: tools.disk__lte disk__n: tools.disk__n has_primary_ip: tools.has_primary_ip id: tools.id id__empty: tools.id__empty id__gt: tools.id__gt id__gte: tools.id__gte id__lt: tools.id__lt id__lte: tools.id__lte id__n: tools.id__n interface_count: tools.interface_count interface_count__empty: tools.interface_count__empty interface_count__gt: tools.interface_count__gt interface_count__gte: tools.interface_count__gte interface_count__lt: tools.interface_count__lt interface_count__lte: tools.interface_count__lte interface_count__n: tools.interface_count__n last_updated: tools.last_updated last_updated__empty: tools.last_updated__empty last_updated__gt: tools.last_updated__gt last_updated__gte: tools.last_updated__gte last_updated__lt: tools.last_updated__lt last_updated__lte: tools.last_updated__lte last_updated__n: tools.last_updated__n limit: tools.limit local_context_data: tools.local_context_data mac_address: tools.mac_address mac_address__ic: tools.mac_address__ic mac_address__ie: tools.mac_address__ie mac_address__iew: tools.mac_address__iew mac_address__iregex: tools.mac_address__iregex mac_address__isw: tools.mac_address__isw mac_address__n: tools.mac_address__n mac_address__nic: tools.mac_address__nic mac_address__nie: tools.mac_address__nie mac_address__niew: tools.mac_address__niew mac_address__nisw: tools.mac_address__nisw mac_address__regex: tools.mac_address__regex memory: tools.memory memory__empty: tools.memory__empty memory__gt: tools.memory__gt memory__gte: tools.memory__gte memory__lt: tools.memory__lt memory__lte: tools.memory__lte memory__n: tools.memory__n modified_by_request: tools.modified_by_request name: tools.name name__empty: tools.name__empty name__ic: tools.name__ic name__ie: tools.name__ie name__iew: tools.name__iew name__iregex: tools.name__iregex name__isw: tools.name__isw name__n: tools.name__n name__nic: tools.name__nic name__nie: tools.name__nie name__niew: tools.name__niew name__nisw: tools.name__nisw name__regex: tools.name__regex offset: tools.offset ordering: tools.ordering owner: tools.owner owner__n: tools.owner__n owner_group: tools.owner_group owner_group__n: tools.owner_group__n owner_group_id: tools.owner_group_id owner_group_id__n: tools.owner_group_id__n owner_id: tools.owner_id owner_id__n: tools.owner_id__n platform: tools.platform platform__n: tools.platform__n platform_id: tools.platform_id platform_id__n: tools.platform_id__n primary_ip4: tools.primary_ip4 primary_ip4__n: tools.primary_ip4__n primary_ip4_id: tools.primary_ip4_id primary_ip4_id__n: tools.primary_ip4_id__n primary_ip6: tools.primary_ip6 primary_ip6__n: tools.primary_ip6__n primary_ip6_id: tools.primary_ip6_id primary_ip6_id__n: tools.primary_ip6_id__n q: tools.q region: tools.region region__n: tools.region__n region_id: tools.region_id region_id__n: tools.region_id__n role: tools.role role__n: tools.role__n role_id: tools.role_id role_id__n: tools.role_id__n serial: tools.serial serial__empty: tools.serial__empty serial__ic: tools.serial__ic serial__ie: tools.serial__ie serial__iew: tools.serial__iew serial__iregex: tools.serial__iregex serial__isw: tools.serial__isw serial__n: tools.serial__n serial__nic: tools.serial__nic serial__nie: tools.serial__nie serial__niew: tools.serial__niew serial__nisw: tools.serial__nisw serial__regex: tools.serial__regex site: tools.site site__n: tools.site__n site_group: tools.site_group site_group__n: tools.site_group__n site_group_id: tools.site_group_id site_group_id__n: tools.site_group_id__n site_id: tools.site_id site_id__n: tools.site_id__n start_on_boot: tools.start_on_boot start_on_boot__empty: tools.start_on_boot__empty start_on_boot__ic: tools.start_on_boot__ic start_on_boot__ie: tools.start_on_boot__ie start_on_boot__iew: tools.start_on_boot__iew start_on_boot__iregex: tools.start_on_boot__iregex start_on_boot__isw: tools.start_on_boot__isw start_on_boot__n: tools.start_on_boot__n start_on_boot__nic: tools.start_on_boot__nic start_on_boot__nie: tools.start_on_boot__nie start_on_boot__niew: tools.start_on_boot__niew start_on_boot__nisw: tools.start_on_boot__nisw start_on_boot__regex: tools.start_on_boot__regex status: tools.status status__empty: tools.status__empty status__ic: tools.status__ic status__ie: tools.status__ie status__iew: tools.status__iew status__iregex: tools.status__iregex status__isw: tools.status__isw status__n: tools.status__n status__nic: tools.status__nic status__nie: tools.status__nie status__niew: tools.status__niew status__nisw: tools.status__nisw status__regex: tools.status__regex tag: tools.tag tag__n: tools.tag__n tag_id: tools.tag_id tag_id__n: tools.tag_id__n tenant: tools.tenant tenant__n: tools.tenant__n tenant_group: tools.tenant_group tenant_group__n: tools.tenant_group__n tenant_group_id: tools.tenant_group_id tenant_group_id__n: tools.tenant_group_id__n tenant_id: tools.tenant_id tenant_id__n: tools.tenant_id__n updated_by_request: tools.updated_by_request vcpus: tools.vcpus vcpus__empty: tools.vcpus__empty vcpus__gt: tools.vcpus__gt vcpus__gte: tools.vcpus__gte vcpus__lt: tools.vcpus__lt vcpus__lte: tools.vcpus__lte vcpus__n: tools.vcpus__n virtual_disk_count: tools.virtual_disk_count virtual_disk_count__empty: tools.virtual_disk_count__empty virtual_disk_count__gt: tools.virtual_disk_count__gt virtual_disk_count__gte: tools.virtual_disk_count__gte virtual_disk_count__lt: tools.virtual_disk_count__lt virtual_disk_count__lte: tools.virtual_disk_count__lte virtual_disk_count__n: tools.virtual_disk_count__n outputParameters: - type: object mapping: $. - name: post-list-virtual-machine-objects description: Post a list of virtual machine objects. hints: readOnly: true destructive: false idempotent: false call: netbox-virtualization.virtualizationvirtualmachinescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: put-list-virtual-machine-objects description: Put a list of virtual machine objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualmachinesbulkupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: patch-list-virtual-machine-objects description: Patch a list of virtual machine objects. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualmachinesbulkpartialupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-list-virtual-machine-objects description: Delete a list of virtual machine objects. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationvirtualmachinesbulkdestroy with: body: tools.body outputParameters: - type: object mapping: $. - name: get-virtual-machine-object description: Get a virtual machine object. hints: readOnly: true destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualmachinesretrieve with: id: tools.id outputParameters: - type: object mapping: $. - name: put-virtual-machine-object description: Put a virtual machine object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualmachinesupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: patch-virtual-machine-object description: Patch a virtual machine object. hints: readOnly: false destructive: false idempotent: true call: netbox-virtualization.virtualizationvirtualmachinespartialupdate with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: delete-virtual-machine-object description: Delete a virtual machine object. hints: readOnly: false destructive: true idempotent: true call: netbox-virtualization.virtualizationvirtualmachinesdestroy with: id: tools.id outputParameters: - type: object mapping: $. - name: resolve-and-render-preferred-configtemplate description: Resolve and render the preferred ConfigTemplate for this Device or Virtual Machine. hints: readOnly: false destructive: false idempotent: false call: netbox-virtualization.virtualizationvirtualmachinesrenderconfigcreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $.