1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getClusterTypes
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger

    Lists cluster_type objects matching the given filters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getClusterTypes({
        filters: [{
            name: "name",
            value: "test-cluster_type",
        }],
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_cluster_types(filters=[{
        "name": "name",
        "value": "test-cluster_type",
    }])
    
    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.GetClusterTypes(ctx, &netbox.GetClusterTypesArgs{
    			Filters: []netbox.GetClusterTypesFilter{
    				{
    					Name:  "name",
    					Value: "test-cluster_type",
    				},
    			},
    		}, 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.GetClusterTypes.Invoke(new()
        {
            Filters = new[]
            {
                new Netbox.Inputs.GetClusterTypesFilterInputArgs
                {
                    Name = "name",
                    Value = "test-cluster_type",
                },
            },
        });
    
    });
    
    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.GetClusterTypesArgs;
    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.getClusterTypes(GetClusterTypesArgs.builder()
                .filters(GetClusterTypesFilterArgs.builder()
                    .name("name")
                    .value("test-cluster_type")
                    .build())
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getClusterTypes
          arguments:
            filters:
              - name: name
                value: test-cluster_type
    
    Example coming soon!
    

    Using getClusterTypes

    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 getClusterTypes(args: GetClusterTypesArgs, opts?: InvokeOptions): Promise<GetClusterTypesResult>
    function getClusterTypesOutput(args: GetClusterTypesOutputArgs, opts?: InvokeOutputOptions): Output<GetClusterTypesResult>
    def get_cluster_types(filters: Optional[Sequence[GetClusterTypesFilter]] = None,
                          limit: Optional[float] = None,
                          opts: Optional[InvokeOptions] = None) -> GetClusterTypesResult
    def get_cluster_types_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetClusterTypesFilterArgs]]]] = None,
                          limit: pulumi.Input[Optional[float]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetClusterTypesResult]
    func GetClusterTypes(ctx *Context, args *GetClusterTypesArgs, opts ...InvokeOption) (*GetClusterTypesResult, error)
    func GetClusterTypesOutput(ctx *Context, args *GetClusterTypesOutputArgs, opts ...InvokeOption) GetClusterTypesResultOutput

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

    public static class GetClusterTypes 
    {
        public static Task<GetClusterTypesResult> InvokeAsync(GetClusterTypesArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterTypesResult> Invoke(GetClusterTypesInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterTypesResult> Invoke(GetClusterTypesInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetClusterTypesResult> getClusterTypes(GetClusterTypesArgs args, InvokeOptions options)
    public static Output<GetClusterTypesResult> getClusterTypes(GetClusterTypesArgs args, InvokeOptions options)
    public static Output<GetClusterTypesResult> getClusterTypes(GetClusterTypesArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getClusterTypes:getClusterTypes
      arguments:
        # arguments dictionary
    data "netbox_get_cluster_types" "name" {
        # arguments
    }

    The following arguments are supported:

    Filters List<GetClusterTypesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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 []GetClusterTypesFilter
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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<GetClusterTypesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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 GetClusterTypesFilter[]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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[GetClusterTypesFilter]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.

    getClusterTypes Result

    The following output properties are available:

    ClusterTypes List<GetClusterTypesClusterType>
    The matching cluster*types.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters List<GetClusterTypesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
    ClusterTypes []GetClusterTypesClusterType
    The matching cluster*types.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters []GetClusterTypesFilter
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
    cluster_types list(object)
    The matching cluster*types.
    id string
    The provider-assigned unique ID for this managed resource.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
    clusterTypes List<GetClusterTypesClusterType>
    The matching cluster*types.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<GetClusterTypesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
    clusterTypes GetClusterTypesClusterType[]
    The matching cluster*types.
    id string
    The provider-assigned unique ID for this managed resource.
    filters GetClusterTypesFilter[]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
    cluster_types Sequence[GetClusterTypesClusterType]
    The matching cluster*types.
    id str
    The provider-assigned unique ID for this managed resource.
    filters Sequence[GetClusterTypesFilter]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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.
    clusterTypes List<Property Map>
    The matching cluster*types.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, slug, slugempty, slugic, slugie, slugiew, slugiregex, slugisw, slugn, slugnic, slugnie, slugniew, slugnisw, slugregex, tag, tagany, tagn, tagid, tagidany, tag_idn. 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

    GetClusterTypesClusterType

    ClusterCount double
    Number of clusters of the cluster type.
    Comments string
    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
    Id double
    NetBox id.
    LastUpdated string
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    Slug string
    URL-friendly unique shorthand; derived from name when not set.
    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
    ClusterCount float64
    Number of clusters of the cluster type.
    Comments string
    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
    Id float64
    NetBox id.
    LastUpdated string
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    Slug string
    URL-friendly unique shorthand; derived from name when not set.
    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
    cluster_count number
    Number of clusters of the cluster type.
    comments string
    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
    id number
    NetBox id.
    last_updated string
    name string
    owner_id number
    Id of the owner the object is assigned to.
    slug string
    URL-friendly unique shorthand; derived from name when not set.
    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
    clusterCount Double
    Number of clusters of the cluster type.
    comments String
    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
    id Double
    NetBox id.
    lastUpdated String
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    slug String
    URL-friendly unique shorthand; derived from name when not set.
    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
    clusterCount number
    Number of clusters of the cluster type.
    comments string
    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
    id number
    NetBox id.
    lastUpdated string
    name string
    ownerId number
    Id of the owner the object is assigned to.
    slug string
    URL-friendly unique shorthand; derived from name when not set.
    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
    cluster_count float
    Number of clusters of the cluster type.
    comments str
    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
    id float
    NetBox id.
    last_updated str
    name str
    owner_id float
    Id of the owner the object is assigned to.
    slug str
    URL-friendly unique shorthand; derived from name when not set.
    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
    clusterCount Number
    Number of clusters of the cluster type.
    comments String
    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
    id Number
    NetBox id.
    lastUpdated String
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    slug String
    URL-friendly unique shorthand; derived from name when not set.
    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

    GetClusterTypesFilter

    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.

    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.1
    published on Monday, Nov 16, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial