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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getRackReservations({
        limit: 10,
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_rack_reservations(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.GetRackReservations(ctx, &netbox.GetRackReservationsArgs{
    			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.GetRackReservations.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.GetRackReservationsArgs;
    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.getRackReservations(GetRackReservationsArgs.builder()
                .limit(10)
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getRackReservations
          arguments:
            limit: 10
    
    Example coming soon!
    

    Using getRackReservations

    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 getRackReservations(args: GetRackReservationsArgs, opts?: InvokeOptions): Promise<GetRackReservationsResult>
    function getRackReservationsOutput(args: GetRackReservationsOutputArgs, opts?: InvokeOutputOptions): Output<GetRackReservationsResult>
    def get_rack_reservations(filters: Optional[Sequence[GetRackReservationsFilter]] = None,
                              limit: Optional[float] = None,
                              opts: Optional[InvokeOptions] = None) -> GetRackReservationsResult
    def get_rack_reservations_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetRackReservationsFilterArgs]]]] = None,
                              limit: pulumi.Input[Optional[float]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetRackReservationsResult]
    func GetRackReservations(ctx *Context, args *GetRackReservationsArgs, opts ...InvokeOption) (*GetRackReservationsResult, error)
    func GetRackReservationsOutput(ctx *Context, args *GetRackReservationsOutputArgs, opts ...InvokeOption) GetRackReservationsResultOutput

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

    public static class GetRackReservations 
    {
        public static Task<GetRackReservationsResult> InvokeAsync(GetRackReservationsArgs args, InvokeOptions? opts = null)
        public static Output<GetRackReservationsResult> Invoke(GetRackReservationsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetRackReservationsResult> Invoke(GetRackReservationsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetRackReservationsResult> getRackReservations(GetRackReservationsArgs args, InvokeOptions options)
    public static Output<GetRackReservationsResult> getRackReservations(GetRackReservationsArgs args, InvokeOptions options)
    public static Output<GetRackReservationsResult> getRackReservations(GetRackReservationsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getRackReservations:getRackReservations
      arguments:
        # arguments dictionary
    data "netbox_get_rack_reservations" "name" {
        # arguments
    }

    The following arguments are supported:

    Filters List<GetRackReservationsFilter>
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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 []GetRackReservationsFilter
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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<GetRackReservationsFilter>
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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 GetRackReservationsFilter[]
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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[GetRackReservationsFilter]
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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.

    getRackReservations Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    RackReservations List<GetRackReservationsRackReservation>
    The matching rack*reservations.
    Filters List<GetRackReservationsFilter>
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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.
    RackReservations []GetRackReservationsRackReservation
    The matching rack*reservations.
    Filters []GetRackReservationsFilter
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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.
    rack_reservations list(object)
    The matching rack*reservations.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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.
    rackReservations List<GetRackReservationsRackReservation>
    The matching rack*reservations.
    filters List<GetRackReservationsFilter>
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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.
    rackReservations GetRackReservationsRackReservation[]
    The matching rack*reservations.
    filters GetRackReservationsFilter[]
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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.
    rack_reservations Sequence[GetRackReservationsRackReservation]
    The matching rack*reservations.
    filters Sequence[GetRackReservationsFilter]
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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.
    rackReservations List<Property Map>
    The matching rack*reservations.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: id, idempty, idgt, idgte, idlt, idlte, idn, ownerid, owneridn, 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

    GetRackReservationsFilter

    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.

    GetRackReservationsRackReservation

    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
    Purpose of the reservation.
    Id double
    NetBox id.
    LastUpdated string
    OwnerId double
    Id of the owner the object is assigned to.
    RackId double
    Id of the rack.
    Status string
    Status of the reservation. One of: pending, active, stale.
    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.
    UnitCount double
    Number of rack units reserved.
    Units List<double>
    Rack unit numbers being reserved.
    Url string
    UserId double
    Id of the NetBox user holding the reservation.
    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
    Purpose of the reservation.
    Id float64
    NetBox id.
    LastUpdated string
    OwnerId float64
    Id of the owner the object is assigned to.
    RackId float64
    Id of the rack.
    Status string
    Status of the reservation. One of: pending, active, stale.
    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.
    UnitCount float64
    Number of rack units reserved.
    Units []float64
    Rack unit numbers being reserved.
    Url string
    UserId float64
    Id of the NetBox user holding the reservation.
    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
    Purpose of the reservation.
    id number
    NetBox id.
    last_updated string
    owner_id number
    Id of the owner the object is assigned to.
    rack_id number
    Id of the rack.
    status string
    Status of the reservation. One of: pending, active, stale.
    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.
    unit_count number
    Number of rack units reserved.
    units list(number)
    Rack unit numbers being reserved.
    url string
    user_id number
    Id of the NetBox user holding the reservation.
    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
    Purpose of the reservation.
    id Double
    NetBox id.
    lastUpdated String
    ownerId Double
    Id of the owner the object is assigned to.
    rackId Double
    Id of the rack.
    status String
    Status of the reservation. One of: pending, active, stale.
    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.
    unitCount Double
    Number of rack units reserved.
    units List<Double>
    Rack unit numbers being reserved.
    url String
    userId Double
    Id of the NetBox user holding the reservation.
    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
    Purpose of the reservation.
    id number
    NetBox id.
    lastUpdated string
    ownerId number
    Id of the owner the object is assigned to.
    rackId number
    Id of the rack.
    status string
    Status of the reservation. One of: pending, active, stale.
    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.
    unitCount number
    Number of rack units reserved.
    units number[]
    Rack unit numbers being reserved.
    url string
    userId number
    Id of the NetBox user holding the reservation.
    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
    Purpose of the reservation.
    id float
    NetBox id.
    last_updated str
    owner_id float
    Id of the owner the object is assigned to.
    rack_id float
    Id of the rack.
    status str
    Status of the reservation. One of: pending, active, stale.
    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.
    unit_count float
    Number of rack units reserved.
    units Sequence[float]
    Rack unit numbers being reserved.
    url str
    user_id float
    Id of the NetBox user holding the reservation.
    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
    Purpose of the reservation.
    id Number
    NetBox id.
    lastUpdated String
    ownerId Number
    Id of the owner the object is assigned to.
    rackId Number
    Id of the rack.
    status String
    Status of the reservation. One of: pending, active, stale.
    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.
    unitCount Number
    Number of rack units reserved.
    units List<Number>
    Rack unit numbers being reserved.
    url String
    userId Number
    Id of the NetBox user holding the reservation.

    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