Fastly Key
CertifiedPurge a single surrogate key from a Fastly service
Fastly Key
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.
type: io.kestra.plugin.fastly.purge.KeyExamples
Purge a surrogate key after a content update
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 *Requiredstring
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 *Requiredstring
Service ID
The Fastly service identifier to purge against.
surrogateKey *Requiredstring
Surrogate key
The surrogate key to purge from the Fastly service cache.
baseUrl string
https://api.fastly.comFastly API base URL
Base URL for the Fastly API. Override this only for testing.
options Non-dynamic
HTTP client options
Optional advanced HTTP settings such as timeouts or proxy configuration.
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.
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.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
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 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.
soft booleanstring
falseSoft 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'.
