Fastly Key

Fastly Key
Certified
Purge a single surrogate key from a Fastly service

Sends a soft or hard purge request for a single surrogate key on a specific Fastly service. Surrogate keys are set on responses via the Surrogate-Key response header. Use Keys to invalidate multiple keys in a single API call.

yaml
type: io.kestra.plugin.fastly.purge.Key

Examples

Purge a surrogate key after a content update

yaml
id: invalidate_product_key
namespace: company.commerce

tasks:
  - id: purge_product
    type: io.kestra.plugin.fastly.purge.Key
    apiToken: "{{ secret('FASTLY_API_TOKEN') }}"
    serviceId: "{{ secret('FASTLY_SERVICE_ID') }}"
    surrogateKey: "product-42"
    soft: true

Properties

apiToken *string

Fastly API token

Your Fastly API token. Create one in the Fastly console under Account > API tokens. Required scopes depend on the operation: URL and surrogate key purges require purge_select; purge-all requires purge_all; stats endpoints require global: read.

serviceId *string

Service ID

The Fastly service identifier to purge against.

surrogateKey *string

Surrogate key

The surrogate key to purge from the Fastly service cache.

baseUrl string

Defaulthttps://api.fastly.com

Fastly API base URL

Base URL for the Fastly API. Override this only for testing.

options

HTTP client options

Optional advanced HTTP settings such as timeouts or proxy configuration.

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.

soft booleanstring

Defaultfalse

Soft purge

When true, marks cached content as stale instead of removing it immediately. Stale content is served while Fastly re-fetches fresh content from the origin. Defaults to false (hard purge).

Outputs

id string

Purge ID

Unique identifier of the purge request, useful for traceability.

status string

Purge status

Status returned by Fastly, typically 'ok'.