1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getInventoryItems
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger

    Lists inventory_item objects matching the given filters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getInventoryItems({
        filters: [{
            name: "name",
            value: "test-inventory_item",
        }],
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_inventory_items(filters=[{
        "name": "name",
        "value": "test-inventory_item",
    }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.GetInventoryItems(ctx, &netbox.GetInventoryItemsArgs{
    			Filters: []netbox.GetInventoryItemsFilter{
    				{
    					Name:  "name",
    					Value: "test-inventory_item",
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Netbox = Pulumi.Netbox;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Netbox.GetInventoryItems.Invoke(new()
        {
            Filters = new[]
            {
                new Netbox.Inputs.GetInventoryItemsFilterInputArgs
                {
                    Name = "name",
                    Value = "test-inventory_item",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netbox.NetboxFunctions;
    import com.pulumi.netbox.inputs.GetInventoryItemsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = NetboxFunctions.getInventoryItems(GetInventoryItemsArgs.builder()
                .filters(GetInventoryItemsFilterArgs.builder()
                    .name("name")
                    .value("test-inventory_item")
                    .build())
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getInventoryItems
          arguments:
            filters:
              - name: name
                value: test-inventory_item
    
    Example coming soon!
    

    Using getInventoryItems

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInventoryItems(args: GetInventoryItemsArgs, opts?: InvokeOptions): Promise<GetInventoryItemsResult>
    function getInventoryItemsOutput(args: GetInventoryItemsOutputArgs, opts?: InvokeOutputOptions): Output<GetInventoryItemsResult>
    def get_inventory_items(filters: Optional[Sequence[GetInventoryItemsFilter]] = None,
                            limit: Optional[float] = None,
                            opts: Optional[InvokeOptions] = None) -> GetInventoryItemsResult
    def get_inventory_items_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetInventoryItemsFilterArgs]]]] = None,
                            limit: pulumi.Input[Optional[float]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetInventoryItemsResult]
    func GetInventoryItems(ctx *Context, args *GetInventoryItemsArgs, opts ...InvokeOption) (*GetInventoryItemsResult, error)
    func GetInventoryItemsOutput(ctx *Context, args *GetInventoryItemsOutputArgs, opts ...InvokeOption) GetInventoryItemsResultOutput

    > Note: This function is named GetInventoryItems in the Go SDK.

    public static class GetInventoryItems 
    {
        public static Task<GetInventoryItemsResult> InvokeAsync(GetInventoryItemsArgs args, InvokeOptions? opts = null)
        public static Output<GetInventoryItemsResult> Invoke(GetInventoryItemsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetInventoryItemsResult> Invoke(GetInventoryItemsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetInventoryItemsResult> getInventoryItems(GetInventoryItemsArgs args, InvokeOptions options)
    public static Output<GetInventoryItemsResult> getInventoryItems(GetInventoryItemsArgs args, InvokeOptions options)
    public static Output<GetInventoryItemsResult> getInventoryItems(GetInventoryItemsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getInventoryItems:getInventoryItems
      arguments:
        # arguments dictionary
    data "netbox_get_inventory_items" "name" {
        # arguments
    }

    The following arguments are supported:

    Filters List<GetInventoryItemsFilter>
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    Limit double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    Filters []GetInventoryItemsFilter
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    Limit float64
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters List<GetInventoryItemsFilter>
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit Double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters GetInventoryItemsFilter[]
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters Sequence[GetInventoryItemsFilter]
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit float
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit Number
    The maximum number of objects to return from the API lookup. Defaults to 1000.

    getInventoryItems Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    InventoryItems List<GetInventoryItemsInventoryItem>
    The matching inventory*items.
    Filters List<GetInventoryItemsFilter>
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    Limit double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    Id string
    The provider-assigned unique ID for this managed resource.
    InventoryItems []GetInventoryItemsInventoryItem
    The matching inventory*items.
    Filters []GetInventoryItemsFilter
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    Limit float64
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id string
    The provider-assigned unique ID for this managed resource.
    inventory_items list(object)
    The matching inventory*items.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id String
    The provider-assigned unique ID for this managed resource.
    inventoryItems List<GetInventoryItemsInventoryItem>
    The matching inventory*items.
    filters List<GetInventoryItemsFilter>
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit Double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id string
    The provider-assigned unique ID for this managed resource.
    inventoryItems GetInventoryItemsInventoryItem[]
    The matching inventory*items.
    filters GetInventoryItemsFilter[]
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id str
    The provider-assigned unique ID for this managed resource.
    inventory_items Sequence[GetInventoryItemsInventoryItem]
    The matching inventory*items.
    filters Sequence[GetInventoryItemsFilter]
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit float
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id String
    The provider-assigned unique ID for this managed resource.
    inventoryItems List<Property Map>
    The matching inventory*items.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: assettag, assettagempty, asset_tagic, asset_tagie, asset_tagiew, asset_tagiregex, asset_tagisw, asset_tagn, asset_tagnic, asset_tagnie, asset_tagniew, asset_tagnisw, asset_tagregex, deviceid, deviceidn, discovered, id, idempty, idgt, idgte, idlt, idlte, idn, label, labelempty, labelic, labelie, labeliew, labeliregex, labelisw, labeln, labelnic, labelnie, labelniew, labelnisw, labelregex, manufacturerid, manufactureridn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, ownerid, owneridn, parentid, parentidn, roleid, roleidn, serial, serialempty, serialic, serialie, serialiew, serialiregex, serialisw, serialn, serialnic, serialnie, serialniew, serialnisw, serialregex, tag, tagany, tag_*n. Repeating a name sends that parameter once per value. Custom fields filter as cf*\n\n, e.g. cf_tier, with the field's own filter logic: loose is a case-insensitive substring match, exact an exact match. NetBox ignores names it has no custom field for, and such an entry does not narrow the result.
    limit Number
    The maximum number of objects to return from the API lookup. Defaults to 1000.

    Supporting Types

    GetInventoryItemsFilter

    Name string
    Name of the query filter (the API list parameter).
    Value string
    Value to filter by.
    Name string
    Name of the query filter (the API list parameter).
    Value string
    Value to filter by.
    name string
    Name of the query filter (the API list parameter).
    value string
    Value to filter by.
    name String
    Name of the query filter (the API list parameter).
    value String
    Value to filter by.
    name string
    Name of the query filter (the API list parameter).
    value string
    Value to filter by.
    name str
    Name of the query filter (the API list parameter).
    value str
    Value to filter by.
    name String
    Name of the query filter (the API list parameter).
    value String
    Value to filter by.

    GetInventoryItemsInventoryItem

    AssetTag string
    Unique asset tag.
    ComponentId double
    Id of the device component named by component_type.
    ComponentType string
    Type of the device component the item is bound to, e.g. dcim.interface. Requires component_id.
    Created string
    CustomFields Dictionary<string, string>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    DeviceId double
    Id of the device.
    Discovered bool
    Whether the item was discovered automatically.
    Id double
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    ManufacturerId double
    Id of the manufacturer.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    ParentId double
    Id of the parent inventory item.
    PartId string
    Manufacturer part number.
    RoleId double
    Id of the inventory item role.
    Serial string
    Serial number.
    Status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning.
    Tags List<string>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls List<string>
    Slugs of all tags on the object, including the provider's default_tags.
    Url string
    AssetTag string
    Unique asset tag.
    ComponentId float64
    Id of the device component named by component_type.
    ComponentType string
    Type of the device component the item is bound to, e.g. dcim.interface. Requires component_id.
    Created string
    CustomFields map[string]string
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    DeviceId float64
    Id of the device.
    Discovered bool
    Whether the item was discovered automatically.
    Id float64
    NetBox id.
    Label string
    Physical label.
    LastUpdated string
    ManufacturerId float64
    Id of the manufacturer.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    ParentId float64
    Id of the parent inventory item.
    PartId string
    Manufacturer part number.
    RoleId float64
    Id of the inventory item role.
    Serial string
    Serial number.
    Status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning.
    Tags []string
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls []string
    Slugs of all tags on the object, including the provider's default_tags.
    Url string
    asset_tag string
    Unique asset tag.
    component_id number
    Id of the device component named by component_type.
    component_type string
    Type of the device component the item is bound to, e.g. dcim.interface. Requires component_id.
    created string
    custom_fields map(string)
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    device_id number
    Id of the device.
    discovered bool
    Whether the item was discovered automatically.
    id number
    NetBox id.
    label string
    Physical label.
    last_updated string
    manufacturer_id number
    Id of the manufacturer.
    name string
    owner_id number
    Id of the owner the object is assigned to.
    parent_id number
    Id of the parent inventory item.
    part_id string
    Manufacturer part number.
    role_id number
    Id of the inventory item role.
    serial string
    Serial number.
    status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning.
    tags list(string)
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls list(string)
    Slugs of all tags on the object, including the provider's default_tags.
    url string
    assetTag String
    Unique asset tag.
    componentId Double
    Id of the device component named by component_type.
    componentType String
    Type of the device component the item is bound to, e.g. dcim.interface. Requires component_id.
    created String
    customFields Map<String,String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    deviceId Double
    Id of the device.
    discovered Boolean
    Whether the item was discovered automatically.
    id Double
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    manufacturerId Double
    Id of the manufacturer.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    parentId Double
    Id of the parent inventory item.
    partId String
    Manufacturer part number.
    roleId Double
    Id of the inventory item role.
    serial String
    Serial number.
    status String
    Operational status. One of: offline, active, planned, staged, failed, decommissioning.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    url String
    assetTag string
    Unique asset tag.
    componentId number
    Id of the device component named by component_type.
    componentType string
    Type of the device component the item is bound to, e.g. dcim.interface. Requires component_id.
    created string
    customFields {[key: string]: string}
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    deviceId number
    Id of the device.
    discovered boolean
    Whether the item was discovered automatically.
    id number
    NetBox id.
    label string
    Physical label.
    lastUpdated string
    manufacturerId number
    Id of the manufacturer.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    parentId number
    Id of the parent inventory item.
    partId string
    Manufacturer part number.
    roleId number
    Id of the inventory item role.
    serial string
    Serial number.
    status string
    Operational status. One of: offline, active, planned, staged, failed, decommissioning.
    tags string[]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls string[]
    Slugs of all tags on the object, including the provider's default_tags.
    url string
    asset_tag str
    Unique asset tag.
    component_id float
    Id of the device component named by component_type.
    component_type str
    Type of the device component the item is bound to, e.g. dcim.interface. Requires component_id.
    created str
    custom_fields Mapping[str, str]
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description str
    device_id float
    Id of the device.
    discovered bool
    Whether the item was discovered automatically.
    id float
    NetBox id.
    label str
    Physical label.
    last_updated str
    manufacturer_id float
    Id of the manufacturer.
    name str
    owner_id float
    Id of the owner the object is assigned to.
    parent_id float
    Id of the parent inventory item.
    part_id str
    Manufacturer part number.
    role_id float
    Id of the inventory item role.
    serial str
    Serial number.
    status str
    Operational status. One of: offline, active, planned, staged, failed, decommissioning.
    tags Sequence[str]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls Sequence[str]
    Slugs of all tags on the object, including the provider's default_tags.
    url str
    assetTag String
    Unique asset tag.
    componentId Number
    Id of the device component named by component_type.
    componentType String
    Type of the device component the item is bound to, e.g. dcim.interface. Requires component_id.
    created String
    customFields Map<String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    deviceId Number
    Id of the device.
    discovered Boolean
    Whether the item was discovered automatically.
    id Number
    NetBox id.
    label String
    Physical label.
    lastUpdated String
    manufacturerId Number
    Id of the manufacturer.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    parentId Number
    Id of the parent inventory item.
    partId String
    Manufacturer part number.
    roleId Number
    Id of the inventory item role.
    serial String
    Serial number.
    status String
    Operational status. One of: offline, active, planned, staged, failed, decommissioning.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    url String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial