1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getCircuits
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 circuit objects matching the given filters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getCircuits({
        limit: 10,
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_circuits(limit=10)
    
    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.GetCircuits(ctx, &netbox.GetCircuitsArgs{
    			Limit: pulumi.Float64Ref(10),
    		}, 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.GetCircuits.Invoke(new()
        {
            Limit = 10,
        });
    
    });
    
    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.GetCircuitsArgs;
    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.getCircuits(GetCircuitsArgs.builder()
                .limit(10)
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getCircuits
          arguments:
            limit: 10
    
    Example coming soon!
    

    Using getCircuits

    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 getCircuits(args: GetCircuitsArgs, opts?: InvokeOptions): Promise<GetCircuitsResult>
    function getCircuitsOutput(args: GetCircuitsOutputArgs, opts?: InvokeOutputOptions): Output<GetCircuitsResult>
    def get_circuits(filters: Optional[Sequence[GetCircuitsFilter]] = None,
                     limit: Optional[float] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCircuitsResult
    def get_circuits_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetCircuitsFilterArgs]]]] = None,
                     limit: pulumi.Input[Optional[float]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetCircuitsResult]
    func GetCircuits(ctx *Context, args *GetCircuitsArgs, opts ...InvokeOption) (*GetCircuitsResult, error)
    func GetCircuitsOutput(ctx *Context, args *GetCircuitsOutputArgs, opts ...InvokeOption) GetCircuitsResultOutput

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

    public static class GetCircuits 
    {
        public static Task<GetCircuitsResult> InvokeAsync(GetCircuitsArgs args, InvokeOptions? opts = null)
        public static Output<GetCircuitsResult> Invoke(GetCircuitsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetCircuitsResult> Invoke(GetCircuitsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetCircuitsResult> getCircuits(GetCircuitsArgs args, InvokeOptions options)
    public static Output<GetCircuitsResult> getCircuits(GetCircuitsArgs args, InvokeOptions options)
    public static Output<GetCircuitsResult> getCircuits(GetCircuitsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getCircuits:getCircuits
      arguments:
        # arguments dictionary
    data "netbox_get_circuits" "name" {
        # arguments
    }

    The following arguments are supported:

    Filters List<GetCircuitsFilter>
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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 []GetCircuitsFilter
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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<GetCircuitsFilter>
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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 GetCircuitsFilter[]
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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[GetCircuitsFilter]
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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.

    getCircuits Result

    The following output properties are available:

    Circuits List<GetCircuitsCircuit>
    The matching circuits.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters List<GetCircuitsFilter>
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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.
    Circuits []GetCircuitsCircuit
    The matching circuits.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters []GetCircuitsFilter
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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.
    circuits list(object)
    The matching circuits.
    id string
    The provider-assigned unique ID for this managed resource.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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.
    circuits List<GetCircuitsCircuit>
    The matching circuits.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<GetCircuitsFilter>
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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.
    circuits GetCircuitsCircuit[]
    The matching circuits.
    id string
    The provider-assigned unique ID for this managed resource.
    filters GetCircuitsFilter[]
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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.
    circuits Sequence[GetCircuitsCircuit]
    The matching circuits.
    id str
    The provider-assigned unique ID for this managed resource.
    filters Sequence[GetCircuitsFilter]
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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.
    circuits List<Property Map>
    The matching circuits.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: cid, cidempty, cidic, cidie, cidiew, cidiregex, cidisw, cidn, cidnic, cidnie, cidniew, cidnisw, cidregex, commitrate, commitrateempty, commit_rategt, commit_rategte, commit_ratelt, commit_ratelte, commit_raten, contact, contactn, contactgroup, contactgroupn, contactrole, contactrolen, created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, distance, distanceempty, distancegt, distancegte, distancelt, distancelte, distancen, distanceunit, distanceunitempty, distance_unitic, distance_unitie, distance_unitiew, distance_unitiregex, distance_unitisw, distance_unitn, distance_unitnic, distance_unitnie, distance_unitniew, distance_unitnisw, distance_unitregex, id, idempty, idgt, idgte, idlt, idlte, idn, installdate, installdateempty, install_dategt, install_dategte, install_datelt, install_datelte, install_daten, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, locationid, locationidn, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, provider, providern, provideraccount, provideraccountn, provideraccountid, provideraccountidn, providerid, provideridn, providernetworkid, providernetworkidn, q, region, regionn, regionid, regionidn, site, siten, sitegroup, sitegroupn, sitegroupid, sitegroupidn, siteid, siteidn, status, statusempty, statusic, statusie, statusiew, statusiregex, statusisw, statusn, statusnic, statusnie, statusniew, statusnisw, statusregex, tag, tagany, tagn, tagid, tagidany, tag_idn, tenant, tenantn, tenantgroup, tenantgroupn, tenantgroupid, tenantgroupidn, tenantid, tenantidn, terminationaid, terminationaidn, terminationdate, terminationdateempty, termination_dategt, termination_dategte, termination_datelt, termination_datelte, termination_daten, terminationzid, terminationzidn, type, typen, typeid, typeid_*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

    GetCircuitsCircuit

    Cid string
    Circuit id assigned by the provider; unique per provider.
    CircuitProviderAccountId double
    Id of the provider account the circuit is billed to.
    CircuitProviderId double
    Id of the provider the circuit is leased from.
    CircuitTypeId double
    Id of the circuit type.
    Comments string
    CommitRateKbps double
    Committed rate in kbps. Must be a whole number.
    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
    Distance double
    Length of the circuit (requires distance_unit).
    DistanceUnit string
    Unit of distance. One of: km, m, mi, ft.
    Id double
    NetBox id.
    InstallDate string
    Installation date as YYYY-MM-DD.
    LastUpdated string
    OwnerId double
    Id of the owner the object is assigned to.
    Status string
    Operational status. One of: planned, provisioning, active, offline, deprovisioning, decommissioned.
    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.
    TenantId double
    Id of the tenant.
    TerminationDate string
    Termination date as YYYY-MM-DD.
    Url string
    Cid string
    Circuit id assigned by the provider; unique per provider.
    CircuitProviderAccountId float64
    Id of the provider account the circuit is billed to.
    CircuitProviderId float64
    Id of the provider the circuit is leased from.
    CircuitTypeId float64
    Id of the circuit type.
    Comments string
    CommitRateKbps float64
    Committed rate in kbps. Must be a whole number.
    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
    Distance float64
    Length of the circuit (requires distance_unit).
    DistanceUnit string
    Unit of distance. One of: km, m, mi, ft.
    Id float64
    NetBox id.
    InstallDate string
    Installation date as YYYY-MM-DD.
    LastUpdated string
    OwnerId float64
    Id of the owner the object is assigned to.
    Status string
    Operational status. One of: planned, provisioning, active, offline, deprovisioning, decommissioned.
    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.
    TenantId float64
    Id of the tenant.
    TerminationDate string
    Termination date as YYYY-MM-DD.
    Url string
    cid string
    Circuit id assigned by the provider; unique per provider.
    circuit_provider_account_id number
    Id of the provider account the circuit is billed to.
    circuit_provider_id number
    Id of the provider the circuit is leased from.
    circuit_type_id number
    Id of the circuit type.
    comments string
    commit_rate_kbps number
    Committed rate in kbps. Must be a whole number.
    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
    distance number
    Length of the circuit (requires distance_unit).
    distance_unit string
    Unit of distance. One of: km, m, mi, ft.
    id number
    NetBox id.
    install_date string
    Installation date as YYYY-MM-DD.
    last_updated string
    owner_id number
    Id of the owner the object is assigned to.
    status string
    Operational status. One of: planned, provisioning, active, offline, deprovisioning, decommissioned.
    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.
    tenant_id number
    Id of the tenant.
    termination_date string
    Termination date as YYYY-MM-DD.
    url string
    cid String
    Circuit id assigned by the provider; unique per provider.
    circuitProviderAccountId Double
    Id of the provider account the circuit is billed to.
    circuitProviderId Double
    Id of the provider the circuit is leased from.
    circuitTypeId Double
    Id of the circuit type.
    comments String
    commitRateKbps Double
    Committed rate in kbps. Must be a whole number.
    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
    distance Double
    Length of the circuit (requires distance_unit).
    distanceUnit String
    Unit of distance. One of: km, m, mi, ft.
    id Double
    NetBox id.
    installDate String
    Installation date as YYYY-MM-DD.
    lastUpdated String
    ownerId Double
    Id of the owner the object is assigned to.
    status String
    Operational status. One of: planned, provisioning, active, offline, deprovisioning, decommissioned.
    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.
    tenantId Double
    Id of the tenant.
    terminationDate String
    Termination date as YYYY-MM-DD.
    url String
    cid string
    Circuit id assigned by the provider; unique per provider.
    circuitProviderAccountId number
    Id of the provider account the circuit is billed to.
    circuitProviderId number
    Id of the provider the circuit is leased from.
    circuitTypeId number
    Id of the circuit type.
    comments string
    commitRateKbps number
    Committed rate in kbps. Must be a whole number.
    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
    distance number
    Length of the circuit (requires distance_unit).
    distanceUnit string
    Unit of distance. One of: km, m, mi, ft.
    id number
    NetBox id.
    installDate string
    Installation date as YYYY-MM-DD.
    lastUpdated string
    ownerId number
    Id of the owner the object is assigned to.
    status string
    Operational status. One of: planned, provisioning, active, offline, deprovisioning, decommissioned.
    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.
    tenantId number
    Id of the tenant.
    terminationDate string
    Termination date as YYYY-MM-DD.
    url string
    cid str
    Circuit id assigned by the provider; unique per provider.
    circuit_provider_account_id float
    Id of the provider account the circuit is billed to.
    circuit_provider_id float
    Id of the provider the circuit is leased from.
    circuit_type_id float
    Id of the circuit type.
    comments str
    commit_rate_kbps float
    Committed rate in kbps. Must be a whole number.
    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
    distance float
    Length of the circuit (requires distance_unit).
    distance_unit str
    Unit of distance. One of: km, m, mi, ft.
    id float
    NetBox id.
    install_date str
    Installation date as YYYY-MM-DD.
    last_updated str
    owner_id float
    Id of the owner the object is assigned to.
    status str
    Operational status. One of: planned, provisioning, active, offline, deprovisioning, decommissioned.
    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.
    tenant_id float
    Id of the tenant.
    termination_date str
    Termination date as YYYY-MM-DD.
    url str
    cid String
    Circuit id assigned by the provider; unique per provider.
    circuitProviderAccountId Number
    Id of the provider account the circuit is billed to.
    circuitProviderId Number
    Id of the provider the circuit is leased from.
    circuitTypeId Number
    Id of the circuit type.
    comments String
    commitRateKbps Number
    Committed rate in kbps. Must be a whole number.
    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
    distance Number
    Length of the circuit (requires distance_unit).
    distanceUnit String
    Unit of distance. One of: km, m, mi, ft.
    id Number
    NetBox id.
    installDate String
    Installation date as YYYY-MM-DD.
    lastUpdated String
    ownerId Number
    Id of the owner the object is assigned to.
    status String
    Operational status. One of: planned, provisioning, active, offline, deprovisioning, decommissioned.
    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.
    tenantId Number
    Id of the tenant.
    terminationDate String
    Termination date as YYYY-MM-DD.
    url String

    GetCircuitsFilter

    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