Cloudflare R2 Purge

Cloudflare R2 Purge

Certified

Purge Cloudflare cached content

Purges cached assets for a Cloudflare zone. Requires purgeAll or at least one file or tag; default keeps the cache unchanged and the task fails if nothing is provided.

yaml
type: io.kestra.plugin.cloudflare.cache.Purge

Purge entire zone cache

yaml
id: purge_all_cache
namespace: company.team

tasks:
  - id: purge_all
    type: io.kestra.plugin.cloudflare.cache.Purge
    apiToken: "{{ secret('CLOUDFLARE_API_TOKEN') }}"
    zoneId: "your_zone_id"
    purgeAll: true

Purge specific files

yaml
id: purge_specific_files
namespace: company.team

tasks:
  - id: purge_files
    type: io.kestra.plugin.cloudflare.cache.Purge
    apiToken: "{{ secret('CLOUDFLARE_API_TOKEN') }}"
    zoneId: "your_zone_id"
    files:
      - "https://example.com/app.js"
Properties

Cloudflare API token

Your Cloudflare API token. Create one in the Cloudflare dashboard with DNS read/write permissions.

Zone ID

Identifier of the Cloudflare zone to purge.

Defaulthttps://api.cloudflare.com/client/v4

Cloudflare API base URL

Base URL for Cloudflare API. Usually you don’t need to change this.

SubTypestring

Files

List of absolute file URLs to purge when not purging everything.

HTTP client options

Optional advanced HTTP settings like timeouts or proxy.

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

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

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

basicAuthUserDeprecatedstring

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

connectTimeoutDeprecatedstring
Formatduration

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

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

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.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

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.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

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

readTimeoutDeprecatedstring
Formatduration

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

ssl

The SSL request options

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.

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.

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

Defaultfalse

Purge entire cache

Set to true to purge the full zone cache; defaults to false and takes precedence over files or tags.

SubTypestring

Cache tags

Cache tags to purge when tags are configured on the zone.

Request ID

Unique identifier of the cache purge request.