Fastly MonthToDateUsage

Fastly MonthToDateUsage

Certified

Fetch Fastly month-to-date usage

Retrieves bandwidth and request counts accumulated since the start of the current billing month via /stats/usage_by_month. No time-window parameters are accepted — Fastly always returns the current month's running totals. The response is keyed by region.

yaml
type: io.kestra.plugin.fastly.stats.MonthToDateUsage

Check month-to-date bandwidth usage

yaml
id: fastly_month_to_date_usage
namespace: company.analytics

tasks:
  - id: fetch_mtd_usage
    type: io.kestra.plugin.fastly.stats.MonthToDateUsage
    apiToken: "{{ secret('FASTLY_API_TOKEN') }}"
Properties

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.

Defaulthttps://api.fastly.com

Fastly API base URL

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

HTTP client options

Optional advanced HTTP settings such as timeouts or proxy configuration.

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.

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.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

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.

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.

Month-to-date usage data

Usage totals since the start of the current billing month, keyed by region.

Response metadata

Metadata returned by Fastly, including pagination info and request parameters.

Response status

Status field from the Fastly API envelope, typically ok.