DigitalOcean Get
CertifiedGet a DigitalOcean database cluster
DigitalOcean Get
Get a DigitalOcean database cluster
Reads a single managed database cluster's details from the DigitalOcean API.
type: io.kestra.plugin.digitalocean.database.GetExamples
Get a database cluster and log its status
id: digitalocean_get_database
namespace: company.team
tasks:
- id: get_database
type: io.kestra.plugin.digitalocean.database.Get
apiToken: "{{ secret('DIGITALOCEAN_TOKEN') }}"
databaseId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- id: log_status
type: io.kestra.plugin.core.log.Log
message: "Database {{ outputs.get_database.name }} is {{ outputs.get_database.status }}"
Properties
apiToken *Requiredstring
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.
databaseId *Requiredstring
Database cluster ID
UUID of the database cluster to read.
baseUrl string
https://api.digitalocean.comDigitalOcean API base URL
Base endpoint for all DigitalOcean API calls. Defaults to https://api.digitalocean.com.
options Non-dynamic
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.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
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.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
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 address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
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.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
engine string
Database engine
One of pg, mysql, redis, mongodb, kafka, or opensearch.
host string
Connection host
Hostname to connect to the cluster's primary connection.
id string
Database cluster ID
UUID assigned by DigitalOcean.
name string
Database cluster name
port integer
Connection port
region string
Region slug
Datacenter region the cluster runs in, e.g. nyc1.
status string
Cluster status
One of creating, online, resizing, or migrating.
