Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. getMicrodropletCheckpoints
Viewing docs for DigitalOcean v4.77.0
published on Friday, Jul 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

digitalocean.getMicrodropletCheckpoints

digitalocean logo
Viewing docs for DigitalOcean v4.77.0
published on Friday, Jul 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

    Fetches the list of checkpoints belonging to a DigitalOcean MicroDroplet.

    Checkpoints are read-only artifacts: DigitalOcean captures one automatically each time a MicroDroplet is paused, preserving the memory and disk state needed to resume. They cannot be created or deleted directly through the customer API, so this provider only exposes them as a data source.

    Example Usage

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

const exampleMicrodroplet = new digitalocean.Microdroplet("example", {
    name: "example-microdroplet",
    region: "nyc3",
    size: "microdroplet-1",
    image: "docker.io/library/nginx:latest",
    autoPause: {
        enabled: true,
        idleTimeout: "5m",
    },
});
const example = digitalocean.getMicrodropletCheckpointsOutput({
    microdropletId: exampleMicrodroplet.id,
});
export const checkpointIds = example.apply(example => .map(c => (c.id)));

    import pulumi
import pulumi_digitalocean as digitalocean

example_microdroplet = digitalocean.Microdroplet("example",
    name="example-microdroplet",
    region="nyc3",
    size="microdroplet-1",
    image="docker.io/library/nginx:latest",
    auto_pause={
        "enabled": True,
        "idle_timeout": "5m",
    })
example = digitalocean.get_microdroplet_checkpoints_output(microdroplet_id=example_microdroplet.id)
pulumi.export("checkpointIds", example.apply(lambda example: [c.id for c in example.checkpoints]))

    Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    var exampleMicrodroplet = new DigitalOcean.Microdroplet("example", new()
    {
        Name = "example-microdroplet",
        Region = "nyc3",
        Size = "microdroplet-1",
        Image = "docker.io/library/nginx:latest",
        AutoPause = new DigitalOcean.Inputs.MicrodropletAutoPauseArgs
        {
            Enabled = true,
            IdleTimeout = "5m",
        },
    });

    var example = DigitalOcean.GetMicrodropletCheckpoints.Invoke(new()
    {
        MicrodropletId = exampleMicrodroplet.Id,
    });

    return new Dictionary<string, object?>
    {
        ["checkpointIds"] = .Select(c => 
        {
            return c.Id;
        }).ToList(),
    };
});

    Example coming soon!

    Example coming soon!

    pulumi {
  required_providers {
    digitalocean = {
      source = "pulumi/digitalocean"
    }
  }
}

data "digitalocean_getmicrodropletcheckpoints" "example" {
  microdroplet_id = digitalocean_microdroplet.example.id
}

resource "digitalocean_microdroplet" "example" {
  name   = "example-microdroplet"
  region = "nyc3"
  size   = "microdroplet-1"
  image  = "docker.io/library/nginx:latest"
  auto_pause = {
    enabled      = true
    idle_timeout = "5m"
  }
}
output "checkpointIds" {
  value = [for c in data.digitalocean_getmicrodropletcheckpoints.example.checkpoints : c.id]
}

    Using getMicrodropletCheckpoints

    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 getMicrodropletCheckpoints(args: GetMicrodropletCheckpointsArgs, opts?: InvokeOptions): Promise<GetMicrodropletCheckpointsResult>
function getMicrodropletCheckpointsOutput(args: GetMicrodropletCheckpointsOutputArgs, opts?: InvokeOptions): Output<GetMicrodropletCheckpointsResult>
    def get_microdroplet_checkpoints(filters: Optional[Sequence[GetMicrodropletCheckpointsFilter]] = None,
                                 microdroplet_id: Optional[str] = None,
                                 sorts: Optional[Sequence[GetMicrodropletCheckpointsSort]] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetMicrodropletCheckpointsResult
def get_microdroplet_checkpoints_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetMicrodropletCheckpointsFilterArgs]]]] = None,
                                 microdroplet_id: pulumi.Input[Optional[str]] = None,
                                 sorts: pulumi.Input[Optional[Sequence[pulumi.Input[GetMicrodropletCheckpointsSortArgs]]]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetMicrodropletCheckpointsResult]
    func GetMicrodropletCheckpoints(ctx *Context, args *GetMicrodropletCheckpointsArgs, opts ...InvokeOption) (*GetMicrodropletCheckpointsResult, error)
func GetMicrodropletCheckpointsOutput(ctx *Context, args *GetMicrodropletCheckpointsOutputArgs, opts ...InvokeOption) GetMicrodropletCheckpointsResultOutput

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

    public static class GetMicrodropletCheckpoints 
{
    public static Task<GetMicrodropletCheckpointsResult> InvokeAsync(GetMicrodropletCheckpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetMicrodropletCheckpointsResult> Invoke(GetMicrodropletCheckpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMicrodropletCheckpointsResult> getMicrodropletCheckpoints(GetMicrodropletCheckpointsArgs args, InvokeOptions options)
public static Output<GetMicrodropletCheckpointsResult> getMicrodropletCheckpoints(GetMicrodropletCheckpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: digitalocean:index/getMicrodropletCheckpoints:getMicrodropletCheckpoints
  arguments:
    # arguments dictionary
    data "digitalocean_get_microdroplet_checkpoints" "name" {
    # arguments
}

    The following arguments are supported:

    MicrodropletId string
    ID of the MicroDroplet whose checkpoints should be listed.
    Filters List<Pulumi.DigitalOcean.Inputs.GetMicrodropletCheckpointsFilter>
    Repeatable client-side filter block:
    Sorts List<Pulumi.DigitalOcean.Inputs.GetMicrodropletCheckpointsSort>
    Repeatable client-side sort block:
    MicrodropletId string
    ID of the MicroDroplet whose checkpoints should be listed.
    Filters []GetMicrodropletCheckpointsFilter
    Repeatable client-side filter block:
    Sorts []GetMicrodropletCheckpointsSort
    Repeatable client-side sort block:
    microdroplet_id string
    ID of the MicroDroplet whose checkpoints should be listed.
    filters list(object)
    Repeatable client-side filter block:
    sorts list(object)
    Repeatable client-side sort block:
    microdropletId String
    ID of the MicroDroplet whose checkpoints should be listed.
    filters List<GetMicrodropletCheckpointsFilter>
    Repeatable client-side filter block:
    sorts List<GetMicrodropletCheckpointsSort>
    Repeatable client-side sort block:
    microdropletId string
    ID of the MicroDroplet whose checkpoints should be listed.
    filters GetMicrodropletCheckpointsFilter[]
    Repeatable client-side filter block:
    sorts GetMicrodropletCheckpointsSort[]
    Repeatable client-side sort block:
    microdroplet_id str
    ID of the MicroDroplet whose checkpoints should be listed.
    filters Sequence[GetMicrodropletCheckpointsFilter]
    Repeatable client-side filter block:
    sorts Sequence[GetMicrodropletCheckpointsSort]
    Repeatable client-side sort block:
    microdropletId String
    ID of the MicroDroplet whose checkpoints should be listed.
    filters List<Property Map>
    Repeatable client-side filter block:
    sorts List<Property Map>
    Repeatable client-side sort block:

    getMicrodropletCheckpoints Result

    The following output properties are available:

    Checkpoints []GetMicrodropletCheckpointsCheckpoint
    A list of checkpoint records. Each entry contains:
    Id string
    The provider-assigned unique ID for this managed resource.
    MicrodropletId string
    ID of the parent MicroDroplet.
    Filters []GetMicrodropletCheckpointsFilter
    Sorts []GetMicrodropletCheckpointsSort
    checkpoints list(object)
    A list of checkpoint records. Each entry contains:
    id string
    The provider-assigned unique ID for this managed resource.
    microdroplet_id string
    ID of the parent MicroDroplet.
    filters list(object)
    sorts list(object)
    checkpoints List<GetMicrodropletCheckpointsCheckpoint>
    A list of checkpoint records. Each entry contains:
    id String
    The provider-assigned unique ID for this managed resource.
    microdropletId String
    ID of the parent MicroDroplet.
    filters List<GetMicrodropletCheckpointsFilter>
    sorts List<GetMicrodropletCheckpointsSort>
    checkpoints GetMicrodropletCheckpointsCheckpoint[]
    A list of checkpoint records. Each entry contains:
    id string
    The provider-assigned unique ID for this managed resource.
    microdropletId string
    ID of the parent MicroDroplet.
    filters GetMicrodropletCheckpointsFilter[]
    sorts GetMicrodropletCheckpointsSort[]
    checkpoints Sequence[GetMicrodropletCheckpointsCheckpoint]
    A list of checkpoint records. Each entry contains:
    id str
    The provider-assigned unique ID for this managed resource.
    microdroplet_id str
    ID of the parent MicroDroplet.
    filters Sequence[GetMicrodropletCheckpointsFilter]
    sorts Sequence[GetMicrodropletCheckpointsSort]
    checkpoints List<Property Map>
    A list of checkpoint records. Each entry contains:
    id String
    The provider-assigned unique ID for this managed resource.
    microdropletId String
    ID of the parent MicroDroplet.
    filters List<Property Map>
    sorts List<Property Map>

    Supporting Types

    GetMicrodropletCheckpointsCheckpoint

    CreatedAt string
    RFC3339 timestamp of when the checkpoint was created.
    DiskBytes int
    Size of the persisted disk image, in bytes.
    Id string
    Checkpoint ID.
    MemoryBytes int
    Size of the persisted memory image, in bytes.
    MicrodropletId string
    ID of the MicroDroplet whose checkpoints should be listed.
    Name string
    Checkpoint name.
    Status string
    Lifecycle status of the checkpoint (e.g. CHECKPOINT_AVAILABLE).
    CreatedAt string
    RFC3339 timestamp of when the checkpoint was created.
    DiskBytes int
    Size of the persisted disk image, in bytes.
    Id string
    Checkpoint ID.
    MemoryBytes int
    Size of the persisted memory image, in bytes.
    MicrodropletId string
    ID of the MicroDroplet whose checkpoints should be listed.
    Name string
    Checkpoint name.
    Status string
    Lifecycle status of the checkpoint (e.g. CHECKPOINT_AVAILABLE).
    created_at string
    RFC3339 timestamp of when the checkpoint was created.
    disk_bytes number
    Size of the persisted disk image, in bytes.
    id string
    Checkpoint ID.
    memory_bytes number
    Size of the persisted memory image, in bytes.
    microdroplet_id string
    ID of the MicroDroplet whose checkpoints should be listed.
    name string
    Checkpoint name.
    status string
    Lifecycle status of the checkpoint (e.g. CHECKPOINT_AVAILABLE).
    createdAt String
    RFC3339 timestamp of when the checkpoint was created.
    diskBytes Integer
    Size of the persisted disk image, in bytes.
    id String
    Checkpoint ID.
    memoryBytes Integer
    Size of the persisted memory image, in bytes.
    microdropletId String
    ID of the MicroDroplet whose checkpoints should be listed.
    name String
    Checkpoint name.
    status String
    Lifecycle status of the checkpoint (e.g. CHECKPOINT_AVAILABLE).
    createdAt string
    RFC3339 timestamp of when the checkpoint was created.
    diskBytes number
    Size of the persisted disk image, in bytes.
    id string
    Checkpoint ID.
    memoryBytes number
    Size of the persisted memory image, in bytes.
    microdropletId string
    ID of the MicroDroplet whose checkpoints should be listed.
    name string
    Checkpoint name.
    status string
    Lifecycle status of the checkpoint (e.g. CHECKPOINT_AVAILABLE).
    created_at str
    RFC3339 timestamp of when the checkpoint was created.
    disk_bytes int
    Size of the persisted disk image, in bytes.
    id str
    Checkpoint ID.
    memory_bytes int
    Size of the persisted memory image, in bytes.
    microdroplet_id str
    ID of the MicroDroplet whose checkpoints should be listed.
    name str
    Checkpoint name.
    status str
    Lifecycle status of the checkpoint (e.g. CHECKPOINT_AVAILABLE).
    createdAt String
    RFC3339 timestamp of when the checkpoint was created.
    diskBytes Number
    Size of the persisted disk image, in bytes.
    id String
    Checkpoint ID.
    memoryBytes Number
    Size of the persisted memory image, in bytes.
    microdropletId String
    ID of the MicroDroplet whose checkpoints should be listed.
    name String
    Checkpoint name.
    status String
    Lifecycle status of the checkpoint (e.g. CHECKPOINT_AVAILABLE).

    GetMicrodropletCheckpointsFilter

    Key string
    Field to match. Valid keys include id, name, status.
    Values List<string>
    List of values to match on key.
    All bool
    Require every value to match. Defaults to false.
    MatchBy string
    exact, re, or substring. Defaults to exact.
    Key string
    Field to match. Valid keys include id, name, status.
    Values []string
    List of values to match on key.
    All bool
    Require every value to match. Defaults to false.
    MatchBy string
    exact, re, or substring. Defaults to exact.
    key string
    Field to match. Valid keys include id, name, status.
    values list(string)
    List of values to match on key.
    all bool
    Require every value to match. Defaults to false.
    match_by string
    exact, re, or substring. Defaults to exact.
    key String
    Field to match. Valid keys include id, name, status.
    values List<String>
    List of values to match on key.
    all Boolean
    Require every value to match. Defaults to false.
    matchBy String
    exact, re, or substring. Defaults to exact.
    key string
    Field to match. Valid keys include id, name, status.
    values string[]
    List of values to match on key.
    all boolean
    Require every value to match. Defaults to false.
    matchBy string
    exact, re, or substring. Defaults to exact.
    key str
    Field to match. Valid keys include id, name, status.
    values Sequence[str]
    List of values to match on key.
    all bool
    Require every value to match. Defaults to false.
    match_by str
    exact, re, or substring. Defaults to exact.
    key String
    Field to match. Valid keys include id, name, status.
    values List<String>
    List of values to match on key.
    all Boolean
    Require every value to match. Defaults to false.
    matchBy String
    exact, re, or substring. Defaults to exact.

    GetMicrodropletCheckpointsSort

    Key string
    Field to sort by (e.g. createdAt).
    Direction string
    asc (default) or desc.
    Key string
    Field to sort by (e.g. createdAt).
    Direction string
    asc (default) or desc.
    key string
    Field to sort by (e.g. createdAt).
    direction string
    asc (default) or desc.
    key String
    Field to sort by (e.g. createdAt).
    direction String
    asc (default) or desc.
    key string
    Field to sort by (e.g. createdAt).
    direction string
    asc (default) or desc.
    key str
    Field to sort by (e.g. createdAt).
    direction str
    asc (default) or desc.
    key String
    Field to sort by (e.g. createdAt).
    direction String
    asc (default) or desc.

    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
    Schema (JSON)
    pulumi/pulumi-digitalocean

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial