Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. UpCloud
  4. API Docs
  5. getServer
Viewing docs for UpCloud v0.17.0
published on Wednesday, Jul 29, 2026 by UpCloudLtd
Schema (JSON)
UpCloudLtd/pulumi-upcloud

upcloud.getServer

upcloud logo
Viewing docs for UpCloud v0.17.0
published on Wednesday, Jul 29, 2026 by UpCloudLtd
Schema (JSON)
UpCloudLtd/pulumi-upcloud

    Provides details about an existing UpCloud cloud server by UUID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as upcloud from "@upcloud/pulumi-upcloud";

const _this = upcloud.getServer({
    id: "00f60089-7bb0-4e19-9481-fbb1cb4378ab",
});

    import pulumi
import pulumi_upcloud as upcloud

this = upcloud.get_server(id="00f60089-7bb0-4e19-9481-fbb1cb4378ab")

    package main

import (
	"github.com/UpCloudLtd/pulumi-upcloud/sdk/go/upcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := upcloud.LookupServer(ctx, &upcloud.LookupServerArgs{
			Id: "00f60089-7bb0-4e19-9481-fbb1cb4378ab",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = UpCloud.GetServer.Invoke(new()
    {
        Id = "00f60089-7bb0-4e19-9481-fbb1cb4378ab",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.upcloud.UpcloudFunctions;
import com.pulumi.upcloud.inputs.GetServerArgs;
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 this = UpcloudFunctions.getServer(GetServerArgs.builder()
            .id("00f60089-7bb0-4e19-9481-fbb1cb4378ab")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: upcloud:getServer
      arguments:
        id: 00f60089-7bb0-4e19-9481-fbb1cb4378ab

    Example coming soon!

    Using getServer

    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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
    def get_server(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(id: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
    func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

    public static class GetServer 
{
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
    public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)

    fn::invoke:
  function: upcloud:index/getServer:getServer
  arguments:
    # arguments dictionary
    data "upcloud_get_server" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Id string
    id string
    id String
    id string
    id str
    id String

    getServer Result

    The following output properties are available:

    BootOrder string
    Cpu int
    Firewall bool
    Host int
    Hostname string
    Id string
    Labels Dictionary<string, string>
    Mem int
    Metadata bool
    NetworkInterfaces List<UpCloud.Pulumi.UpCloud.Outputs.GetServerNetworkInterface>
    NicModel string
    Plan string
    ServerGroup string
    State string
    Tags List<string>
    Timezone string
    Title string
    VideoModel string
    Zone string
    BootOrder string
    Cpu int
    Firewall bool
    Host int
    Hostname string
    Id string
    Labels map[string]string
    Mem int
    Metadata bool
    NetworkInterfaces []GetServerNetworkInterface
    NicModel string
    Plan string
    ServerGroup string
    State string
    Tags []string
    Timezone string
    Title string
    VideoModel string
    Zone string
    boot_order string
    cpu number
    firewall bool
    host number
    hostname string
    id string
    labels map(string)
    mem number
    metadata bool
    network_interfaces list(object)
    nic_model string
    plan string
    server_group string
    state string
    tags list(string)
    timezone string
    title string
    video_model string
    zone string
    bootOrder String
    cpu Integer
    firewall Boolean
    host Integer
    hostname String
    id String
    labels Map<String,String>
    mem Integer
    metadata Boolean
    networkInterfaces List<GetServerNetworkInterface>
    nicModel String
    plan String
    serverGroup String
    state String
    tags List<String>
    timezone String
    title String
    videoModel String
    zone String
    bootOrder string
    cpu number
    firewall boolean
    host number
    hostname string
    id string
    labels {[key: string]: string}
    mem number
    metadata boolean
    networkInterfaces GetServerNetworkInterface[]
    nicModel string
    plan string
    serverGroup string
    state string
    tags string[]
    timezone string
    title string
    videoModel string
    zone string
    bootOrder String
    cpu Number
    firewall Boolean
    host Number
    hostname String
    id String
    labels Map<String>
    mem Number
    metadata Boolean
    networkInterfaces List<Property Map>
    nicModel String
    plan String
    serverGroup String
    state String
    tags List<String>
    timezone String
    title String
    videoModel String
    zone String

    Supporting Types

    GetServerNetworkInterface

    AdditionalIpAddresses List<UpCloud.Pulumi.UpCloud.Inputs.GetServerNetworkInterfaceAdditionalIpAddress>
    Additional IP addresses for this interface. Only available for private network interfaces.
    Bootable bool
    true indicates that the server can boot from this interface.
    Index int
    The interface index.
    IpAddress string
    The primary IP address of this interface.
    IpAddressFamily string
    The type of the primary IP address (IPv4 or IPv6).
    IpAddressFloating bool
    true indicates that the primary IP address is a floating IP address.
    MacAddress string
    The MAC address of the interface.
    Network string
    The UUID of the network the interface is attached to.
    SourceIpFiltering bool
    true indicates that source IP filtering is enabled for this interface.
    Type string
    The type of the network interface (public, private, or utility).
    AdditionalIpAddresses []GetServerNetworkInterfaceAdditionalIpAddress
    Additional IP addresses for this interface. Only available for private network interfaces.
    Bootable bool
    true indicates that the server can boot from this interface.
    Index int
    The interface index.
    IpAddress string
    The primary IP address of this interface.
    IpAddressFamily string
    The type of the primary IP address (IPv4 or IPv6).
    IpAddressFloating bool
    true indicates that the primary IP address is a floating IP address.
    MacAddress string
    The MAC address of the interface.
    Network string
    The UUID of the network the interface is attached to.
    SourceIpFiltering bool
    true indicates that source IP filtering is enabled for this interface.
    Type string
    The type of the network interface (public, private, or utility).
    additional_ip_addresses list(object)
    Additional IP addresses for this interface. Only available for private network interfaces.
    bootable bool
    true indicates that the server can boot from this interface.
    index number
    The interface index.
    ip_address string
    The primary IP address of this interface.
    ip_address_family string
    The type of the primary IP address (IPv4 or IPv6).
    ip_address_floating bool
    true indicates that the primary IP address is a floating IP address.
    mac_address string
    The MAC address of the interface.
    network string
    The UUID of the network the interface is attached to.
    source_ip_filtering bool
    true indicates that source IP filtering is enabled for this interface.
    type string
    The type of the network interface (public, private, or utility).
    additionalIpAddresses List<GetServerNetworkInterfaceAdditionalIpAddress>
    Additional IP addresses for this interface. Only available for private network interfaces.
    bootable Boolean
    true indicates that the server can boot from this interface.
    index Integer
    The interface index.
    ipAddress String
    The primary IP address of this interface.
    ipAddressFamily String
    The type of the primary IP address (IPv4 or IPv6).
    ipAddressFloating Boolean
    true indicates that the primary IP address is a floating IP address.
    macAddress String
    The MAC address of the interface.
    network String
    The UUID of the network the interface is attached to.
    sourceIpFiltering Boolean
    true indicates that source IP filtering is enabled for this interface.
    type String
    The type of the network interface (public, private, or utility).
    additionalIpAddresses GetServerNetworkInterfaceAdditionalIpAddress[]
    Additional IP addresses for this interface. Only available for private network interfaces.
    bootable boolean
    true indicates that the server can boot from this interface.
    index number
    The interface index.
    ipAddress string
    The primary IP address of this interface.
    ipAddressFamily string
    The type of the primary IP address (IPv4 or IPv6).
    ipAddressFloating boolean
    true indicates that the primary IP address is a floating IP address.
    macAddress string
    The MAC address of the interface.
    network string
    The UUID of the network the interface is attached to.
    sourceIpFiltering boolean
    true indicates that source IP filtering is enabled for this interface.
    type string
    The type of the network interface (public, private, or utility).
    additional_ip_addresses Sequence[GetServerNetworkInterfaceAdditionalIpAddress]
    Additional IP addresses for this interface. Only available for private network interfaces.
    bootable bool
    true indicates that the server can boot from this interface.
    index int
    The interface index.
    ip_address str
    The primary IP address of this interface.
    ip_address_family str
    The type of the primary IP address (IPv4 or IPv6).
    ip_address_floating bool
    true indicates that the primary IP address is a floating IP address.
    mac_address str
    The MAC address of the interface.
    network str
    The UUID of the network the interface is attached to.
    source_ip_filtering bool
    true indicates that source IP filtering is enabled for this interface.
    type str
    The type of the network interface (public, private, or utility).
    additionalIpAddresses List<Property Map>
    Additional IP addresses for this interface. Only available for private network interfaces.
    bootable Boolean
    true indicates that the server can boot from this interface.
    index Number
    The interface index.
    ipAddress String
    The primary IP address of this interface.
    ipAddressFamily String
    The type of the primary IP address (IPv4 or IPv6).
    ipAddressFloating Boolean
    true indicates that the primary IP address is a floating IP address.
    macAddress String
    The MAC address of the interface.
    network String
    The UUID of the network the interface is attached to.
    sourceIpFiltering Boolean
    true indicates that source IP filtering is enabled for this interface.
    type String
    The type of the network interface (public, private, or utility).

    GetServerNetworkInterfaceAdditionalIpAddress

    IpAddress string
    An additional IP address for this interface.
    IpAddressFamily string
    The type of the additional IP address (IPv4 or IPv6).
    IpAddressFloating bool
    true indicates that the additional IP address is a floating IP address.
    IpAddress string
    An additional IP address for this interface.
    IpAddressFamily string
    The type of the additional IP address (IPv4 or IPv6).
    IpAddressFloating bool
    true indicates that the additional IP address is a floating IP address.
    ip_address string
    An additional IP address for this interface.
    ip_address_family string
    The type of the additional IP address (IPv4 or IPv6).
    ip_address_floating bool
    true indicates that the additional IP address is a floating IP address.
    ipAddress String
    An additional IP address for this interface.
    ipAddressFamily String
    The type of the additional IP address (IPv4 or IPv6).
    ipAddressFloating Boolean
    true indicates that the additional IP address is a floating IP address.
    ipAddress string
    An additional IP address for this interface.
    ipAddressFamily string
    The type of the additional IP address (IPv4 or IPv6).
    ipAddressFloating boolean
    true indicates that the additional IP address is a floating IP address.
    ip_address str
    An additional IP address for this interface.
    ip_address_family str
    The type of the additional IP address (IPv4 or IPv6).
    ip_address_floating bool
    true indicates that the additional IP address is a floating IP address.
    ipAddress String
    An additional IP address for this interface.
    ipAddressFamily String
    The type of the additional IP address (IPv4 or IPv6).
    ipAddressFloating Boolean
    true indicates that the additional IP address is a floating IP address.

    Package Details

    Repository
    upcloud UpCloudLtd/pulumi-upcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the upcloud Terraform Provider.
    upcloud logo
    Viewing docs for UpCloud v0.17.0
    published on Wednesday, Jul 29, 2026 by UpCloudLtd
    Schema (JSON)
    UpCloudLtd/pulumi-upcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial