Pure Storage FlashArray Restore
CertifiedEnterprise EditionRestore a Pure Storage FlashArray snapshot into a new volume
Pure Storage FlashArray Restore
Restore a Pure Storage FlashArray snapshot into a new volume
Creates a new volume as a full copy of an existing snapshot via POST /api/{version}/volumes?names={targetVolumeName}
with a source reference to the snapshot. This is non-destructive: the source snapshot and its parent volume
are left untouched. If a volume named targetVolumeName already exists, FlashArray rejects the request rather
than overwriting it — the array's error is surfaced as-is.
type: io.kestra.plugin.ee.purestorage.snapshots.RestoreExamples
Restore a snapshot into a new volume.
id: purestorage_restore_snapshot
namespace: company.team
tasks:
- id: restore_snapshot
type: io.kestra.plugin.ee.purestorage.snapshots.Restore
host: "{{ secret('PURESTORAGE_HOST') }}"
apiToken: "{{ secret('PURESTORAGE_API_TOKEN') }}"
snapshotName: "{{ inputs.snapshot_name }}"
targetVolumeName: "{{ inputs.volume_name }}_restored"
Properties
apiToken *Requiredstring
FlashArray API token
Static API token used to authenticate. It is exchanged for a short-lived session token via the FlashArray
login endpoint; this plugin does not perform the username/password to API-token exchange.
Store this value as a Kestra secret and reference it via {{ secret('PURESTORAGE_API_TOKEN') }}.
host *Requiredstring
FlashArray management IP or hostname
Hostname or IP address of the Pure Storage FlashArray management interface (for example: flasharray.example.com or 192.168.1.20).
The REST API is reached at https://{host}: {port}/api/.
snapshotName *Requiredstring
Snapshot name
Full snapshot name to restore from, in {volumeName}.{suffix} format.
targetVolumeName *Requiredstring
Target volume name
Name of the new volume to create from the snapshot. Must not already exist on the array.
apiVersion string
REST API version override
Pins the Purity//FA REST API version to use (for example: 2.30), bypassing runtime version discovery
(GET /api/api_version). Optional: when unset, the highest supported 2.x version is auto-detected.
options Non-dynamic
HTTP client configuration
Optional HTTP client overrides such as timeouts, TLS settings, and proxy. When timeout is
not set, a default 10s connect / 60s read-idle timeout is applied so an unreachable or stalled
array fails fast with a clear error instead of hanging the task indefinitely; set timeout
explicitly to override. For example:
options:
timeout:
connectTimeout: PT10S
readIdleTimeout: PT30S
ssl:
insecureTrustAllCertificates: true # accept self-signed array certs (insecure — lab use only)
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.
port integerstring
443FlashArray port
Port for the FlashArray REST API. Defaults to 443.
scheme string
httpsHTTP scheme
Protocol scheme used to reach the FlashArray REST API. Defaults to https.
Set to http only for testing against local stubs; production arrays always use https.
Outputs
id string
New volume ID
ID assigned by FlashArray to the restored volume.
