DigitalOcean Get
CertifiedGet a DigitalOcean snapshot
DigitalOcean Get
Get a DigitalOcean snapshot
Reads a single droplet or volume snapshot's details from the DigitalOcean API.
type: io.kestra.plugin.digitalocean.snapshot.GetExamples
Get a snapshot and log its size
id: digitalocean_get_snapshot
namespace: company.team
tasks:
- id: get_snapshot
type: io.kestra.plugin.digitalocean.snapshot.Get
apiToken: "{{ secret('DIGITALOCEAN_TOKEN') }}"
snapshotId: "fbe805e8-866b-11e6-96bf-000f53315a41"
- id: log_size
type: io.kestra.plugin.core.log.Log
message: "Snapshot {{ outputs.get_snapshot.name }} takes {{ outputs.get_snapshot.sizeGigabytes }} GB"
Properties
apiToken *string
DigitalOcean API token
Personal access token used to authenticate against the DigitalOcean API v2, sent as Authorization: Bearer <token>. Create one (prefixed dop_v1_) in the DigitalOcean control panel under API > Tokens, and store it as a Kestra secret.
snapshotId *string
Snapshot ID
ID of the snapshot to read: numeric for a droplet snapshot, a UUID for a volume snapshot.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
https://api.digitalocean.comDigitalOcean API base URL
Base endpoint for all DigitalOcean API calls. Defaults to https://api.digitalocean.com.
options
HTTP client options
Optional HTTP configuration (timeouts, proxy, SSL) applied to every DigitalOcean API call.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
Outputs
createdAt string
date-timeCreation timestamp
id string
Snapshot ID
Numeric for a droplet snapshot, a UUID for a volume snapshot.
minDiskSize integer
Minimum disk size in GB
Smallest disk a droplet or volume needs to use this snapshot.
name string
Snapshot name
regions array
Region slugs
Regions the snapshot is available in, e.g. nyc3.
resourceId string
Resource ID
ID of the droplet or volume the snapshot was taken from.
resourceType string
Resource type
Type of resource the snapshot was taken from: droplet or volume.
sizeGigabytes number
Billable size in GB
