1. Packages
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. getMicrodroplet
Viewing docs for DigitalOcean v4.77.0
published on Friday, Jul 31, 2026 by Pulumi
digitalocean logo
Viewing docs for DigitalOcean v4.77.0
published on Friday, Jul 31, 2026 by Pulumi

    Fetches a single DigitalOcean MicroDroplet by id or by name.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const byid = digitalocean.getMicrodroplet({
        id: "506f78a4-e098-11e5-ad9f-000f53306ae1",
    });
    const byname = digitalocean.getMicrodroplet({
        name: "my-microdroplet",
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    byid = digitalocean.get_microdroplet(id="506f78a4-e098-11e5-ad9f-000f53306ae1")
    byname = digitalocean.get_microdroplet(name="my-microdroplet")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := digitalocean.GetMicrodroplet(ctx, &digitalocean.LookupMicrodropletArgs{
    			Id: pulumi.StringRef("506f78a4-e098-11e5-ad9f-000f53306ae1"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = digitalocean.GetMicrodroplet(ctx, &digitalocean.LookupMicrodropletArgs{
    			Name: pulumi.StringRef("my-microdroplet"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var byid = DigitalOcean.GetMicrodroplet.Invoke(new()
        {
            Id = "506f78a4-e098-11e5-ad9f-000f53306ae1",
        });
    
        var byname = DigitalOcean.GetMicrodroplet.Invoke(new()
        {
            Name = "my-microdroplet",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DigitaloceanFunctions;
    import com.pulumi.digitalocean.inputs.GetMicrodropletArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 byid = DigitaloceanFunctions.getMicrodroplet(GetMicrodropletArgs.builder()
                .id("506f78a4-e098-11e5-ad9f-000f53306ae1")
                .build());
    
            final var byname = DigitaloceanFunctions.getMicrodroplet(GetMicrodropletArgs.builder()
                .name("my-microdroplet")
                .build());
    
        }
    }
    
    variables:
      byid:
        fn::invoke:
          function: digitalocean:getMicrodroplet
          arguments:
            id: 506f78a4-e098-11e5-ad9f-000f53306ae1
      byname:
        fn::invoke:
          function: digitalocean:getMicrodroplet
          arguments:
            name: my-microdroplet
    
    pulumi {
      required_providers {
        digitalocean = {
          source = "pulumi/digitalocean"
        }
      }
    }
    
    data "digitalocean_getmicrodroplet" "byid" {
      id = "506f78a4-e098-11e5-ad9f-000f53306ae1"
    }
    data "digitalocean_getmicrodroplet" "byname" {
      name = "my-microdroplet"
    }
    

    Using getMicrodroplet

    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 getMicrodroplet(args: GetMicrodropletArgs, opts?: InvokeOptions): Promise<GetMicrodropletResult>
    function getMicrodropletOutput(args: GetMicrodropletOutputArgs, opts?: InvokeOptions): Output<GetMicrodropletResult>
    def get_microdroplet(id: Optional[str] = None,
                         name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetMicrodropletResult
    def get_microdroplet_output(id: pulumi.Input[Optional[str]] = None,
                         name: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetMicrodropletResult]
    func LookupMicrodroplet(ctx *Context, args *LookupMicrodropletArgs, opts ...InvokeOption) (*LookupMicrodropletResult, error)
    func LookupMicrodropletOutput(ctx *Context, args *LookupMicrodropletOutputArgs, opts ...InvokeOption) LookupMicrodropletResultOutput

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

    public static class GetMicrodroplet 
    {
        public static Task<GetMicrodropletResult> InvokeAsync(GetMicrodropletArgs args, InvokeOptions? opts = null)
        public static Output<GetMicrodropletResult> Invoke(GetMicrodropletInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMicrodropletResult> getMicrodroplet(GetMicrodropletArgs args, InvokeOptions options)
    public static Output<GetMicrodropletResult> getMicrodroplet(GetMicrodropletArgs args, InvokeOptions options)
    
    fn::invoke:
      function: digitalocean:index/getMicrodroplet:getMicrodroplet
      arguments:
        # arguments dictionary
    data "digitalocean_get_microdroplet" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    The MicroDroplet UUID.
    Name string
    The MicroDroplet name. Errors if zero or more than one match.
    Id string
    The MicroDroplet UUID.
    Name string
    The MicroDroplet name. Errors if zero or more than one match.
    id string
    The MicroDroplet UUID.
    name string
    The MicroDroplet name. Errors if zero or more than one match.
    id String
    The MicroDroplet UUID.
    name String
    The MicroDroplet name. Errors if zero or more than one match.
    id string
    The MicroDroplet UUID.
    name string
    The MicroDroplet name. Errors if zero or more than one match.
    id str
    The MicroDroplet UUID.
    name str
    The MicroDroplet name. Errors if zero or more than one match.
    id String
    The MicroDroplet UUID.
    name String
    The MicroDroplet name. Errors if zero or more than one match.

    getMicrodroplet Result

    The following output properties are available:

    AutoPauses List<Pulumi.DigitalOcean.Outputs.GetMicrodropletAutoPause>
    AutoResume bool
    CreatedAt string
    CurrentState string
    Endpoint string
    Environment Dictionary<string, string>
    HttpPort int
    HttpProtocol string
    Id string
    Image string
    Name string
    Networking string
    Region string
    , size, image, networking, vpcUuid, httpPort, httpProtocol, environment, autoPause, autoResume, endpoint, currentState, createdAt, urn.
    Size string
    State string
    Urn string
    VpcUuid string
    AutoPauses []GetMicrodropletAutoPause
    AutoResume bool
    CreatedAt string
    CurrentState string
    Endpoint string
    Environment map[string]string
    HttpPort int
    HttpProtocol string
    Id string
    Image string
    Name string
    Networking string
    Region string
    , size, image, networking, vpcUuid, httpPort, httpProtocol, environment, autoPause, autoResume, endpoint, currentState, createdAt, urn.
    Size string
    State string
    Urn string
    VpcUuid string
    auto_pauses list(object)
    auto_resume bool
    created_at string
    current_state string
    endpoint string
    environment map(string)
    http_port number
    http_protocol string
    id string
    image string
    name string
    networking string
    region string
    , size, image, networking, vpcUuid, httpPort, httpProtocol, environment, autoPause, autoResume, endpoint, currentState, createdAt, urn.
    size string
    state string
    urn string
    vpc_uuid string
    autoPauses List<GetMicrodropletAutoPause>
    autoResume Boolean
    createdAt String
    currentState String
    endpoint String
    environment Map<String,String>
    httpPort Integer
    httpProtocol String
    id String
    image String
    name String
    networking String
    region String
    , size, image, networking, vpcUuid, httpPort, httpProtocol, environment, autoPause, autoResume, endpoint, currentState, createdAt, urn.
    size String
    state String
    urn String
    vpcUuid String
    autoPauses GetMicrodropletAutoPause[]
    autoResume boolean
    createdAt string
    currentState string
    endpoint string
    environment {[key: string]: string}
    httpPort number
    httpProtocol string
    id string
    image string
    name string
    networking string
    region string
    , size, image, networking, vpcUuid, httpPort, httpProtocol, environment, autoPause, autoResume, endpoint, currentState, createdAt, urn.
    size string
    state string
    urn string
    vpcUuid string
    auto_pauses Sequence[GetMicrodropletAutoPause]
    auto_resume bool
    created_at str
    current_state str
    endpoint str
    environment Mapping[str, str]
    http_port int
    http_protocol str
    id str
    image str
    name str
    networking str
    region str
    , size, image, networking, vpcUuid, httpPort, httpProtocol, environment, autoPause, autoResume, endpoint, currentState, createdAt, urn.
    size str
    state str
    urn str
    vpc_uuid str
    autoPauses List<Property Map>
    autoResume Boolean
    createdAt String
    currentState String
    endpoint String
    environment Map<String>
    httpPort Number
    httpProtocol String
    id String
    image String
    name String
    networking String
    region String
    , size, image, networking, vpcUuid, httpPort, httpProtocol, environment, autoPause, autoResume, endpoint, currentState, createdAt, urn.
    size String
    state String
    urn String
    vpcUuid String

    Supporting Types

    GetMicrodropletAutoPause

    Enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    IdleTimeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    Enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    IdleTimeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idle_timeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled Boolean
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idleTimeout String
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled boolean
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idleTimeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idle_timeout str
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled Boolean
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idleTimeout String
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    Viewing docs for DigitalOcean v4.77.0
    published on Friday, Jul 31, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial