Pure Storage FlashArray Create

Pure Storage FlashArray Create
Certified
Enterprise Edition
Create a Pure Storage FlashArray volume snapshot

Creates a point-in-time snapshot of a FlashArray volume via POST /api/{version}/volume-snapshots?source_names={volumeName}. The resulting snapshot is named {volumeName}.{suffix}; if suffix is omitted, FlashArray generates one automatically.

yaml
type: io.kestra.plugin.ee.purestorage.snapshots.Create

Examples

Create a snapshot of a volume on demand.

yaml
id: purestorage_create_snapshot
namespace: company.team

tasks:
  - id: create_snapshot
    type: io.kestra.plugin.ee.purestorage.snapshots.Create
    host: "{{ secret('PURESTORAGE_HOST') }}"
    apiToken: "{{ secret('PURESTORAGE_API_TOKEN') }}"
    volumeName: "{{ inputs.volume_name }}"
    suffix: "kestra_{{ execution.startDate | date('yyyyMMdd_HHmmss') }}"

Create a daily snapshot of a volume on a schedule (every day at 02: 00 UTC).

yaml
id: purestorage_daily_snapshot
namespace: company.team

variables:
  volume_name: vol_kestra_demo

tasks:
  - id: create_snapshot
    type: io.kestra.plugin.ee.purestorage.snapshots.Create
    host: "{{ secret('PURESTORAGE_HOST') }}"
    apiToken: "{{ secret('PURESTORAGE_API_TOKEN') }}"
    volumeName: "{{ vars.volume_name }}"
    suffix: "daily_{{ trigger.date ?? execution.startDate | date('yyyyMMdd') }}"

triggers:
  - id: daily
    type: io.kestra.plugin.core.trigger.Schedule
    cron: "0 2 * * *"

Properties

apiToken *string

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 *string

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/.

volumeName *string

Volume name

Name of the FlashArray volume on which to create the snapshot.

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

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)

Definitions

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailedbooleanstring

Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray

SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type*object

passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type*object

tokenstring

The token for bearer token authentication.

io.kestra.core.http.client.configurations.DigestAuthConfiguration

type*object

passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutstring

Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutstring

Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring

DefaultUTF-8

The default charset for the request.

java.nio.charset.Charset

enabledTcpExtendedKeepAlivebooleanstring

Defaulttrue

Whether 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.

followRedirectsbooleanstring

Defaulttrue

Whether redirects should be followed automatically.

logLevelstring

Possible Values

ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray

SubTypestring

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthinteger

The maximum content length of the response.

proxy

The proxy configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring

DefaultDIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressstring

The address of the proxy server.

proxyPasswordstring

The password for proxy authentication.

proxyPortinteger

The port of the proxy server.

proxyTypestring

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernamestring

The username for proxy authentication.

readIdleTimeoutstring

Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutstring

Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificatesbooleanstring

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.

timeout

The timeout configuration.

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring

DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

port integerstring

Default443

FlashArray port

Port for the FlashArray REST API. Defaults to 443.

scheme string

Defaulthttps

HTTP 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.

suffix string

Snapshot suffix

Suffix appended to the volume name to form the snapshot name (for example: daily_20240101 → vol1.daily_20240101). Optional: FlashArray generates one automatically when omitted.

Outputs

id string

Snapshot ID

ID assigned by FlashArray to the newly created snapshot.

snapshotName string

Snapshot name

Full snapshot name in {volumeName}.{suffix} format.