getInstances

civo 1.1.7, Sep 14 25

civo 1.1.7 published on Sunday, Sep 14, 2025 by civo

Schema (JSON)

civo/terraform-provider-civo

civo 1.1.7 published on Sunday, Sep 14, 2025 by civo

Schema (JSON)

civo/terraform-provider-civo

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as civo from "@pulumi/civo";

const small_size = civo.getInstances({
    region: "LON1",
    filters: [{
        key: "size",
        values: [g3.small],
    }],
});

import pulumi
import pulumi_civo as civo

small_size = civo.get_instances(region="LON1",
    filters=[{
        "key": "size",
        "values": [g3["small"]],
    }])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/civo/civo"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := civo.GetInstances(ctx, &civo.GetInstancesArgs{
Region: pulumi.StringRef("LON1"),
Filters: []civo.GetInstancesFilter{
{
Key: "size",
Values: interface{}{
g3.Small,
},
},
},
}, nil);
if err != nil {
return err
}
return nil
})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Civo = Pulumi.Civo;

return await Deployment.RunAsync(() => 
{
    var small_size = Civo.GetInstances.Invoke(new()
    {
        Region = "LON1",
        Filters = new[]
        {
            new Civo.Inputs.GetInstancesFilterInputArgs
            {
                Key = "size",
                Values = new[]
                {
                    g3.Small,
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.civo.CivoFunctions;
import com.pulumi.civo.inputs.GetInstancesArgs;
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 small-size = CivoFunctions.getInstances(GetInstancesArgs.builder()
            .region("LON1")
            .filters(GetInstancesFilterArgs.builder()
                .key("size")
                .values(g3.small())
                .build())
            .build());

    }
}

variables:
  small-size:
    fn::invoke:
      function: civo:getInstances
      arguments:
        region: LON1
        filters:
          - key: size
            values:
              - ${g3.small}

Using getInstances

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 getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>

def get_instances(filters: Optional[Sequence[GetInstancesFilter]] = None,
                  id: Optional[str] = None,
                  region: Optional[str] = None,
                  sorts: Optional[Sequence[GetInstancesSort]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstancesFilterArgs]]]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  region: Optional[pulumi.Input[str]] = None,
                  sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstancesSortArgs]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]

func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

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

public static class GetInstances 
{
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
public static Output<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)

fn::invoke:
  function: civo:index/getInstances:getInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetInstancesFilter>: One or more key/value pairs on which to filter results
Id string: The ID of this resource.
Region string: If used, all instances will be from the provided region
Sorts List<GetInstancesSort>: One or more key/direction pairs on which to sort results

Filters []GetInstancesFilter: One or more key/value pairs on which to filter results
Id string: The ID of this resource.
Region string: If used, all instances will be from the provided region
Sorts []GetInstancesSort: One or more key/direction pairs on which to sort results

filters List<GetInstancesFilter>: One or more key/value pairs on which to filter results
id String: The ID of this resource.
region String: If used, all instances will be from the provided region
sorts List<GetInstancesSort>: One or more key/direction pairs on which to sort results

filters GetInstancesFilter[]: One or more key/value pairs on which to filter results
id string: The ID of this resource.
region string: If used, all instances will be from the provided region
sorts GetInstancesSort[]: One or more key/direction pairs on which to sort results

filters Sequence[GetInstancesFilter]: One or more key/value pairs on which to filter results
id str: The ID of this resource.
region str: If used, all instances will be from the provided region
sorts Sequence[GetInstancesSort]: One or more key/direction pairs on which to sort results

filters List<Property Map>: One or more key/value pairs on which to filter results
id String: The ID of this resource.
region String: If used, all instances will be from the provided region
sorts List<Property Map>: One or more key/direction pairs on which to sort results

getInstances Result

The following output properties are available:

Id string: The ID of this resource.
Instances List<GetInstancesInstance>
Filters List<GetInstancesFilter>: One or more key/value pairs on which to filter results
Region string: If used, all instances will be from the provided region
Sorts List<GetInstancesSort>: One or more key/direction pairs on which to sort results

Id string: The ID of this resource.
Instances []GetInstancesInstance
Filters []GetInstancesFilter: One or more key/value pairs on which to filter results
Region string: If used, all instances will be from the provided region
Sorts []GetInstancesSort: One or more key/direction pairs on which to sort results

id String: The ID of this resource.
instances List<GetInstancesInstance>
filters List<GetInstancesFilter>: One or more key/value pairs on which to filter results
region String: If used, all instances will be from the provided region
sorts List<GetInstancesSort>: One or more key/direction pairs on which to sort results

id string: The ID of this resource.
instances GetInstancesInstance[]
filters GetInstancesFilter[]: One or more key/value pairs on which to filter results
region string: If used, all instances will be from the provided region
sorts GetInstancesSort[]: One or more key/direction pairs on which to sort results

id str: The ID of this resource.
instances Sequence[GetInstancesInstance]
filters Sequence[GetInstancesFilter]: One or more key/value pairs on which to filter results
region str: If used, all instances will be from the provided region
sorts Sequence[GetInstancesSort]: One or more key/direction pairs on which to sort results

id String: The ID of this resource.
instances List<Property Map>
filters List<Property Map>: One or more key/value pairs on which to filter results
region String: If used, all instances will be from the provided region
sorts List<Property Map>: One or more key/direction pairs on which to sort results

Supporting Types

GetInstancesFilter

Key string: Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
Values List<string>: Only retrieves instances which keys has value that matches one of the values provided here
All bool: Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
MatchBy string: One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

Key string: Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
Values []string: Only retrieves instances which keys has value that matches one of the values provided here
All bool: Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
MatchBy string: One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

key String: Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
values List<String>: Only retrieves instances which keys has value that matches one of the values provided here
all Boolean: Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
matchBy String: One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

key string: Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
values string[]: Only retrieves instances which keys has value that matches one of the values provided here
all boolean: Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
matchBy string: One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

key str: Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
values Sequence[str]: Only retrieves instances which keys has value that matches one of the values provided here
all bool: Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
match_by str: One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

key String: Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
values List<String>: Only retrieves instances which keys has value that matches one of the values provided here
all Boolean: Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
matchBy String: One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

GetInstancesInstance

CpuCores double
CreatedAt string
DiskGb double
FirewallId string
Hostname string
Id string
InitialPassword string
InitialUser string
NetworkId string
Notes string
PrivateIp string
PseudoIp string
PublicIp string
RamMb double
Region string
ReverseDns string
Script string
Size string
SshkeyId string
Status string
Tags List<string>
Template string

CpuCores float64
CreatedAt string
DiskGb float64
FirewallId string
Hostname string
Id string
InitialPassword string
InitialUser string
NetworkId string
Notes string
PrivateIp string
PseudoIp string
PublicIp string
RamMb float64
Region string
ReverseDns string
Script string
Size string
SshkeyId string
Status string
Tags []string
Template string

cpuCores Double
createdAt String
diskGb Double
firewallId String
hostname String
id String
initialPassword String
initialUser String
networkId String
notes String
privateIp String
pseudoIp String
publicIp String
ramMb Double
region String
reverseDns String
script String
size String
sshkeyId String
status String
tags List<String>
template String

cpuCores number
createdAt string
diskGb number
firewallId string
hostname string
id string
initialPassword string
initialUser string
networkId string
notes string
privateIp string
pseudoIp string
publicIp string
ramMb number
region string
reverseDns string
script string
size string
sshkeyId string
status string
tags string[]
template string

cpu_cores float
created_at str
disk_gb float
firewall_id str
hostname str
id str
initial_password str
initial_user str
network_id str
notes str
private_ip str
pseudo_ip str
public_ip str
ram_mb float
region str
reverse_dns str
script str
size str
sshkey_id str
status str
tags Sequence[str]
template str

cpuCores Number
createdAt String
diskGb Number
firewallId String
hostname String
id String
initialPassword String
initialUser String
networkId String
notes String
privateIp String
pseudoIp String
publicIp String
ramMb Number
region String
reverseDns String
script String
size String
sshkeyId String
status String
tags List<String>
template String

GetInstancesSort

Key string: Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
Direction string: The sort direction. This may be either asc or desc.

Key string: Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
Direction string: The sort direction. This may be either asc or desc.

key String: Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
direction String: The sort direction. This may be either asc or desc.

key string: Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
direction string: The sort direction. This may be either asc or desc.

key str: Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
direction str: The sort direction. This may be either asc or desc.

key String: Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
direction String: The sort direction. This may be either asc or desc.

Package Details

Repository: Civo civo/terraform-provider-civo
License
Notes: This Pulumi package is based on the civo Terraform Provider.

civo 1.1.7 published on Sunday, Sep 14, 2025 by civo

Schema (JSON)

civo/terraform-provider-civo

civo.getInstances

On this page

On this page

Example Usage

Using getInstances

getInstances Result

Supporting Types

GetInstancesFilter

GetInstancesInstance

GetInstancesSort

Package Details

On this page

On this page