digitalocean.getMicrovmCheckpoints

DigitalOcean v4.84.1, Oct 13 26

Viewing docs for DigitalOcean v4.84.1
published on Tuesday, Oct 13, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-digitalocean

Viewing docs for DigitalOcean v4.84.1
published on Tuesday, Oct 13, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-digitalocean

Example Usage

Get the checkpoints captured from a MicroVM and restore the newest one:

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

const web = digitalocean.getMicrovmCheckpoints({
    microvmId: webDigitaloceanMicrovm.id,
    filters: [{
        key: "status",
        values: ["CHECKPOINT_AVAILABLE"],
    }],
    sorts: [{
        key: "created_at",
        direction: "desc",
    }],
});
const restored = new digitalocean.Microvm("restored", {
    name: "example-restored",
    source: {
        checkpointId: web.then(web => web.checkpoints?.[0]?.id),
    },
});

import pulumi
import pulumi_digitalocean as digitalocean

web = digitalocean.get_microvm_checkpoints(microvm_id=web_digitalocean_microvm["id"],
    filters=[{
        "key": "status",
        "values": ["CHECKPOINT_AVAILABLE"],
    }],
    sorts=[{
        "key": "created_at",
        "direction": "desc",
    }])
restored = digitalocean.Microvm("restored",
    name="example-restored",
    source={
        "checkpoint_id": web.checkpoints[0].id,
    })

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 {
		web, err := digitalocean.GetMicrovmCheckpoints(ctx, &digitalocean.GetMicrovmCheckpointsArgs{
			MicrovmId: pulumi.StringRef(webDigitaloceanMicrovm.Id),
			Filters: []digitalocean.GetMicrovmCheckpointsFilter{
				{
					Key: "status",
					Values: []string{
						"CHECKPOINT_AVAILABLE",
					},
				},
			},
			Sorts: []digitalocean.GetMicrovmCheckpointsSort{
				{
					Key:       "created_at",
					Direction: pulumi.StringRef("desc"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = digitalocean.NewMicrovm(ctx, "restored", &digitalocean.MicrovmArgs{
			Name: pulumi.String("example-restored"),
			Source: &digitalocean.MicrovmSourceArgs{
				CheckpointId: pulumi.String(web.Checkpoints[0].Id),
			},
		})
		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 web = DigitalOcean.GetMicrovmCheckpoints.Invoke(new()
    {
        MicrovmId = webDigitaloceanMicrovm.Id,
        Filters = new[]
        {
            new DigitalOcean.Inputs.GetMicrovmCheckpointsFilterInputArgs
            {
                Key = "status",
                Values = new[]
                {
                    "CHECKPOINT_AVAILABLE",
                },
            },
        },
        Sorts = new[]
        {
            new DigitalOcean.Inputs.GetMicrovmCheckpointsSortInputArgs
            {
                Key = "created_at",
                Direction = "desc",
            },
        },
    });

    var restored = new DigitalOcean.Microvm("restored", new()
    {
        Name = "example-restored",
        Source = new DigitalOcean.Inputs.MicrovmSourceArgs
        {
            CheckpointId = web.Apply(getMicrovmCheckpointsResult => getMicrovmCheckpointsResult.Checkpoints[0]?.Id),
        },
    });

});

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.GetMicrovmCheckpointsArgs;
import com.pulumi.digitalocean.inputs.GetMicrovmCheckpointsFilterArgs;
import com.pulumi.digitalocean.inputs.GetMicrovmCheckpointsSortArgs;
import com.pulumi.digitalocean.Microvm;
import com.pulumi.digitalocean.MicrovmArgs;
import com.pulumi.digitalocean.inputs.MicrovmSourceArgs;
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 web = DigitaloceanFunctions.getMicrovmCheckpoints(GetMicrovmCheckpointsArgs.builder()
            .microvmId(webDigitaloceanMicrovm.get("id"))
            .filters(GetMicrovmCheckpointsFilterArgs.builder()
                .key("status")
                .values("CHECKPOINT_AVAILABLE")
                .build())
            .sorts(GetMicrovmCheckpointsSortArgs.builder()
                .key("created_at")
                .direction("desc")
                .build())
            .build());

        var restored = new Microvm("restored", MicrovmArgs.builder()
            .name("example-restored")
            .source(MicrovmSourceArgs.builder()
                .checkpointId(web.checkpoints()[0].id())
                .build())
            .build());

    }
}

resources:
  restored:
    type: digitalocean:Microvm
    properties:
      name: example-restored
      source:
        checkpointId: ${web.checkpoints[0].id}
variables:
  web:
    fn::invoke:
      function: digitalocean:getMicrovmCheckpoints
      arguments:
        microvmId: ${webDigitaloceanMicrovm.id}
        filters:
          - key: status
            values:
              - CHECKPOINT_AVAILABLE
        sorts:
          - key: created_at
            direction: desc

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

data "digitalocean_microvm_checkpoints" "web" {
  microvm_id = webDigitaloceanMicrovm.id
  filters {
    key    = "status"
    values = ["CHECKPOINT_AVAILABLE"]
  }
  sorts {
    key       = "created_at"
    direction = "desc"
  }
}

resource "digitalocean_microvm" "restored" {
  lifecycle {
    create_before_destroy = true
  }
  name = "example-restored"
  source = {
    checkpoint_id = data.digitalocean_microvm_checkpoints.web.checkpoints[0].id
  }
}

Using getMicrovmCheckpoints

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 getMicrovmCheckpoints(args: GetMicrovmCheckpointsArgs, opts?: InvokeOptions): Promise<GetMicrovmCheckpointsResult>
function getMicrovmCheckpointsOutput(args: GetMicrovmCheckpointsOutputArgs, opts?: InvokeOutputOptions): Output<GetMicrovmCheckpointsResult>

def get_microvm_checkpoints(filters: Optional[Sequence[GetMicrovmCheckpointsFilter]] = None,
                            microvm_id: Optional[str] = None,
                            sorts: Optional[Sequence[GetMicrovmCheckpointsSort]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetMicrovmCheckpointsResult
def get_microvm_checkpoints_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetMicrovmCheckpointsFilterArgs]]]] = None,
                            microvm_id: pulumi.Input[Optional[str]] = None,
                            sorts: pulumi.Input[Optional[Sequence[pulumi.Input[GetMicrovmCheckpointsSortArgs]]]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetMicrovmCheckpointsResult]

func GetMicrovmCheckpoints(ctx *Context, args *GetMicrovmCheckpointsArgs, opts ...InvokeOption) (*GetMicrovmCheckpointsResult, error)
func GetMicrovmCheckpointsOutput(ctx *Context, args *GetMicrovmCheckpointsOutputArgs, opts ...InvokeOption) GetMicrovmCheckpointsResultOutput

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

public static class GetMicrovmCheckpoints 
{
    public static Task<GetMicrovmCheckpointsResult> InvokeAsync(GetMicrovmCheckpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetMicrovmCheckpointsResult> Invoke(GetMicrovmCheckpointsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetMicrovmCheckpointsResult> Invoke(GetMicrovmCheckpointsInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetMicrovmCheckpointsResult> getMicrovmCheckpoints(GetMicrovmCheckpointsArgs args, InvokeOptions options)
public static Output<GetMicrovmCheckpointsResult> getMicrovmCheckpoints(GetMicrovmCheckpointsArgs args, InvokeOptions options)
public static Output<GetMicrovmCheckpointsResult> getMicrovmCheckpoints(GetMicrovmCheckpointsArgs args, InvokeOutputOptions options)

fn::invoke:
  function: digitalocean:index/getMicrovmCheckpoints:getMicrovmCheckpoints
  arguments:
    # arguments dictionary

data "digitalocean_get_microvm_checkpoints" "name" {
    # arguments
}

The following arguments are supported:

Filters List<Pulumi.DigitalOcean.Inputs.GetMicrovmCheckpointsFilter>: Filter the results. The filter block is documented below.
MicrovmId string: Only return checkpoints captured from this MicroVM.
Sorts List<Pulumi.DigitalOcean.Inputs.GetMicrovmCheckpointsSort>: Sort the results. The sort block is documented below.

Filters []GetMicrovmCheckpointsFilter: Filter the results. The filter block is documented below.
MicrovmId string: Only return checkpoints captured from this MicroVM.
Sorts []GetMicrovmCheckpointsSort: Sort the results. The sort block is documented below.

filters list(object): Filter the results. The filter block is documented below.
microvm_id string: Only return checkpoints captured from this MicroVM.
sorts list(object): Sort the results. The sort block is documented below.

filters List<GetMicrovmCheckpointsFilter>: Filter the results. The filter block is documented below.
microvmId String: Only return checkpoints captured from this MicroVM.
sorts List<GetMicrovmCheckpointsSort>: Sort the results. The sort block is documented below.

filters GetMicrovmCheckpointsFilter[]: Filter the results. The filter block is documented below.
microvmId string: Only return checkpoints captured from this MicroVM.
sorts GetMicrovmCheckpointsSort[]: Sort the results. The sort block is documented below.

filters Sequence[GetMicrovmCheckpointsFilter]: Filter the results. The filter block is documented below.
microvm_id str: Only return checkpoints captured from this MicroVM.
sorts Sequence[GetMicrovmCheckpointsSort]: Sort the results. The sort block is documented below.

filters List<Property Map>: Filter the results. The filter block is documented below.
microvmId String: Only return checkpoints captured from this MicroVM.
sorts List<Property Map>: Sort the results. The sort block is documented below.

getMicrovmCheckpoints Result

The following output properties are available:

Checkpoints List<Pulumi.DigitalOcean.Outputs.GetMicrovmCheckpointsCheckpoint>: A list of checkpoints satisfying any filter and sort criteria. Each checkpoint has the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Filters List<Pulumi.DigitalOcean.Outputs.GetMicrovmCheckpointsFilter>
MicrovmId string: The ID of the MicroVM the checkpoint was captured from.
Sorts List<Pulumi.DigitalOcean.Outputs.GetMicrovmCheckpointsSort>

Checkpoints []GetMicrovmCheckpointsCheckpoint: A list of checkpoints satisfying any filter and sort criteria. Each checkpoint has the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Filters []GetMicrovmCheckpointsFilter
MicrovmId string: The ID of the MicroVM the checkpoint was captured from.
Sorts []GetMicrovmCheckpointsSort

checkpoints list(object): A list of checkpoints satisfying any filter and sort criteria. Each checkpoint has the following attributes:
id string: The provider-assigned unique ID for this managed resource.
filters list(object)
microvm_id string: The ID of the MicroVM the checkpoint was captured from.
sorts list(object)

checkpoints List<GetMicrovmCheckpointsCheckpoint>: A list of checkpoints satisfying any filter and sort criteria. Each checkpoint has the following attributes:
id String: The provider-assigned unique ID for this managed resource.
filters List<GetMicrovmCheckpointsFilter>
microvmId String: The ID of the MicroVM the checkpoint was captured from.
sorts List<GetMicrovmCheckpointsSort>

checkpoints GetMicrovmCheckpointsCheckpoint[]: A list of checkpoints satisfying any filter and sort criteria. Each checkpoint has the following attributes:
id string: The provider-assigned unique ID for this managed resource.
filters GetMicrovmCheckpointsFilter[]
microvmId string: The ID of the MicroVM the checkpoint was captured from.
sorts GetMicrovmCheckpointsSort[]

checkpoints Sequence[GetMicrovmCheckpointsCheckpoint]: A list of checkpoints satisfying any filter and sort criteria. Each checkpoint has the following attributes:
id str: The provider-assigned unique ID for this managed resource.
filters Sequence[GetMicrovmCheckpointsFilter]
microvm_id str: The ID of the MicroVM the checkpoint was captured from.
sorts Sequence[GetMicrovmCheckpointsSort]

checkpoints List<Property Map>: A list of checkpoints satisfying any filter and sort criteria. Each checkpoint has the following attributes:
id String: The provider-assigned unique ID for this managed resource.
filters List<Property Map>
microvmId String: The ID of the MicroVM the checkpoint was captured from.
sorts List<Property Map>

Supporting Types

GetMicrovmCheckpointsCheckpoint

CreatedAt string: The date and time the checkpoint was created.
DiskBytes int: The size of the persisted disk image in bytes.
Id string: The ID of the checkpoint.
MemoryBytes int: The size of the persisted memory image in bytes.
MicrovmId string: Only return checkpoints captured from this MicroVM.
MicrovmName string: The name of the MicroVM the checkpoint was captured from.
Name string: The name of the checkpoint.
Region string: The slug of the region the checkpoint is stored in.
Sizes List<Pulumi.DigitalOcean.Inputs.GetMicrovmCheckpointsCheckpointSize>: The size a MicroVM restored from this checkpoint inherits (cpu, memory, disk). Empty when the checkpoint does not record one.
Status string: The status of the checkpoint, such as CHECKPOINT_AVAILABLE.

CreatedAt string: The date and time the checkpoint was created.
DiskBytes int: The size of the persisted disk image in bytes.
Id string: The ID of the checkpoint.
MemoryBytes int: The size of the persisted memory image in bytes.
MicrovmId string: Only return checkpoints captured from this MicroVM.
MicrovmName string: The name of the MicroVM the checkpoint was captured from.
Name string: The name of the checkpoint.
Region string: The slug of the region the checkpoint is stored in.
Sizes []GetMicrovmCheckpointsCheckpointSize: The size a MicroVM restored from this checkpoint inherits (cpu, memory, disk). Empty when the checkpoint does not record one.
Status string: The status of the checkpoint, such as CHECKPOINT_AVAILABLE.

created_at string: The date and time the checkpoint was created.
disk_bytes number: The size of the persisted disk image in bytes.
id string: The ID of the checkpoint.
memory_bytes number: The size of the persisted memory image in bytes.
microvm_id string: Only return checkpoints captured from this MicroVM.
microvm_name string: The name of the MicroVM the checkpoint was captured from.
name string: The name of the checkpoint.
region string: The slug of the region the checkpoint is stored in.
sizes list(object): The size a MicroVM restored from this checkpoint inherits (cpu, memory, disk). Empty when the checkpoint does not record one.
status string: The status of the checkpoint, such as CHECKPOINT_AVAILABLE.

createdAt String: The date and time the checkpoint was created.
diskBytes Integer: The size of the persisted disk image in bytes.
id String: The ID of the checkpoint.
memoryBytes Integer: The size of the persisted memory image in bytes.
microvmId String: Only return checkpoints captured from this MicroVM.
microvmName String: The name of the MicroVM the checkpoint was captured from.
name String: The name of the checkpoint.
region String: The slug of the region the checkpoint is stored in.
sizes List<GetMicrovmCheckpointsCheckpointSize>: The size a MicroVM restored from this checkpoint inherits (cpu, memory, disk). Empty when the checkpoint does not record one.
status String: The status of the checkpoint, such as CHECKPOINT_AVAILABLE.

createdAt string: The date and time the checkpoint was created.
diskBytes number: The size of the persisted disk image in bytes.
id string: The ID of the checkpoint.
memoryBytes number: The size of the persisted memory image in bytes.
microvmId string: Only return checkpoints captured from this MicroVM.
microvmName string: The name of the MicroVM the checkpoint was captured from.
name string: The name of the checkpoint.
region string: The slug of the region the checkpoint is stored in.
sizes GetMicrovmCheckpointsCheckpointSize[]: The size a MicroVM restored from this checkpoint inherits (cpu, memory, disk). Empty when the checkpoint does not record one.
status string: The status of the checkpoint, such as CHECKPOINT_AVAILABLE.

created_at str: The date and time the checkpoint was created.
disk_bytes int: The size of the persisted disk image in bytes.
id str: The ID of the checkpoint.
memory_bytes int: The size of the persisted memory image in bytes.
microvm_id str: Only return checkpoints captured from this MicroVM.
microvm_name str: The name of the MicroVM the checkpoint was captured from.
name str: The name of the checkpoint.
region str: The slug of the region the checkpoint is stored in.
sizes Sequence[GetMicrovmCheckpointsCheckpointSize]: The size a MicroVM restored from this checkpoint inherits (cpu, memory, disk). Empty when the checkpoint does not record one.
status str: The status of the checkpoint, such as CHECKPOINT_AVAILABLE.

createdAt String: The date and time the checkpoint was created.
diskBytes Number: The size of the persisted disk image in bytes.
id String: The ID of the checkpoint.
memoryBytes Number: The size of the persisted memory image in bytes.
microvmId String: Only return checkpoints captured from this MicroVM.
microvmName String: The name of the MicroVM the checkpoint was captured from.
name String: The name of the checkpoint.
region String: The slug of the region the checkpoint is stored in.
sizes List<Property Map>: The size a MicroVM restored from this checkpoint inherits (cpu, memory, disk). Empty when the checkpoint does not record one.
status String: The status of the checkpoint, such as CHECKPOINT_AVAILABLE.

GetMicrovmCheckpointsCheckpointSize

Cpu int: Number of vCPUs
Disk int: Attached disk in GB
Memory int: Memory in MiB

Cpu int: Number of vCPUs
Disk int: Attached disk in GB
Memory int: Memory in MiB

cpu number: Number of vCPUs
disk number: Attached disk in GB
memory number: Memory in MiB

cpu Integer: Number of vCPUs
disk Integer: Attached disk in GB
memory Integer: Memory in MiB

cpu number: Number of vCPUs
disk number: Attached disk in GB
memory number: Memory in MiB

cpu int: Number of vCPUs
disk int: Attached disk in GB
memory int: Memory in MiB

cpu Number: Number of vCPUs
disk Number: Attached disk in GB
memory Number: Memory in MiB

GetMicrovmCheckpointsFilter

Key string: Filter the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
Values List<string>: A list of values to match against the key field.
All bool: Set to true to require that a field match all of the values instead of just one or more of them.
MatchBy string: One of exact (default), re, or substring.

Key string: Filter the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
Values []string: A list of values to match against the key field.
All bool: Set to true to require that a field match all of the values instead of just one or more of them.
MatchBy string: One of exact (default), re, or substring.

key string: Filter the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
values list(string): A list of values to match against the key field.
all bool: Set to true to require that a field match all of the values instead of just one or more of them.
match_by string: One of exact (default), re, or substring.

key String: Filter the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
values List<String>: A list of values to match against the key field.
all Boolean: Set to true to require that a field match all of the values instead of just one or more of them.
matchBy String: One of exact (default), re, or substring.

key string: Filter the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
values string[]: A list of values to match against the key field.
all boolean: Set to true to require that a field match all of the values instead of just one or more of them.
matchBy string: One of exact (default), re, or substring.

key str: Filter the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
values Sequence[str]: A list of values to match against the key field.
all bool: Set to true to require that a field match all of the values instead of just one or more of them.
match_by str: One of exact (default), re, or substring.

key String: Filter the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
values List<String>: A list of values to match against the key field.
all Boolean: Set to true to require that a field match all of the values instead of just one or more of them.
matchBy String: One of exact (default), re, or substring.

GetMicrovmCheckpointsSort

Key string: Sort the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
Direction string: The sort direction. This may be either asc or desc.

Key string: Sort the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
Direction string: The sort direction. This may be either asc or desc.

key string: Sort the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
direction string: The sort direction. This may be either asc or desc.

key String: Sort the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
direction String: The sort direction. This may be either asc or desc.

key string: Sort the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
direction string: The sort direction. This may be either asc or desc.

key str: Sort the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
direction str: The sort direction. This may be either asc or desc.

key String: Sort the checkpoints by this key. This may be one of id, name, microvmId, microvmName, region, status, memoryBytes, diskBytes, or createdAt.
direction String: The sort direction. This may be either asc or desc.

Package Details

Repository: DigitalOcean pulumi/pulumi-digitalocean
License: Apache-2.0
Notes: This Pulumi package is based on the digitalocean Terraform Provider.

Viewing docs for DigitalOcean v4.84.1
published on Tuesday, Oct 13, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-digitalocean

digitalocean.getMicrovmCheckpoints

On this page

On this page

Example Usage

Using getMicrovmCheckpoints

getMicrovmCheckpoints Result

Supporting Types

GetMicrovmCheckpointsCheckpoint

GetMicrovmCheckpointsCheckpointSize

GetMicrovmCheckpointsFilter

GetMicrovmCheckpointsSort

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

digitalocean.getMicrovmCheckpoints

On this page

On this page

Example Usage

Using getMicrovmCheckpoints

getMicrovmCheckpoints Result

Supporting Types

GetMicrovmCheckpointsCheckpoint

GetMicrovmCheckpointsCheckpointSize

GetMicrovmCheckpointsFilter

GetMicrovmCheckpointsSort

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.