Index of all API Endpoints

Get information on current and past bills.

A billing address is used to calculate your bill correctly.

Get information on billing usage metrics.

A Customer Contact is the base object that holds the different types of contact information Fastly uses to contact a customer.

A Customer is the base object that owns your Users and Services. Some information may be limited depending on access level.

Event logs are used to audit actions performed by customers.

Invitations allow superusers and engineers to invite users to set up accounts as collaborators under a main customer account. Superusers can invite collaborators and assign them any role or permission level on a per-service basis. Engineers with no per-service limitations on their role can only invite new collaborators but cannot modify their permissions.

Get information on current and past invoices.

A service authorization allows limited users to access only specified services.

A star allows users to mark services of interest.

A user of the Fastly API and web interface. A user is always associated with a customer. Some information may be limited depending on access level.

An access control list or "ACL" specifies individual IP addresses or subnet ranges and can be accessed and used from Fastly VCL.

An ACL entry holds an individual IP address or subnet range and is a member of an ACL. ACL entries are versionless, which means they can be created, modified, or deleted without activating a new version of your service.

Automation tokens differ from other token types because they are not tied to a specific person and therefore are not subject to the lifecycle of such accounts. Automation tokens are sometimes also called "service accounts". They are designed for API automation use-cases such as continuous integration, deployment pipelines, or automation scripts. For more information about authentication tokens, review the Authentication token documentation.

An API Token is used to identify who is making the API call. Users can create multiple tokens to suit their needs.

A Dictionary is a VCL data table that stores key-value pairs accessible to VCL during request processing. New, empty dictionaries can be attached to a draft version of a service, which must be activated for the dictionary to be included in VCL. Once installed, a dictionary's items may be updated via API calls without having to activate a new version of the associated service configuration. To remove a dictionary, delete it on a draft version of a service (one that is not locked and not active). Once removed, activate the draft service version without the dictionary.

Dictionary Info is a set of metadata describing properties of a dictionary which change as items are added and removed.

A Dictionary Item is a single key-value pair that makes up an entry in a Dictionary. Dictionary Items can be added, removed and modified without activating a new version of the associated service.

The Domains API allows you to manage your domains on Fastly and the services that they interact with.

Customers with access to multiple sets of IP pools are able to manage DNS records associated with the IP pools.

Customers with access to multiple sets of IP pools can apply different configuration options to their TLS-enabled domains.

Configuration sets are used to view and select the available versions of the Fastly WAF rules.

Firewall object used when configuring WAF.

OWASP settings object used when configuring WAF.

Rules used when configuring WAF.

A Rule status represents the status of a particular rule for a given firewall. For a rule to be attached to a particular firewall and performing any actions, a rule status must exist.

Retrieve the currently deployed WAF ruleset VCL and the date it was deployed.

Tags for categorizing WAF rules. Tags can be filtered by name.

Update status indicates the status of an asynchronous process for updating a firewall object.

Maps and relates backends as belonging to directors. Backends can belong to any number of directors but directors can only hold one reference to a specific backend.

A Director is responsible for balancing requests among a group of Backends. In addition to simply balancing, Directors can be configured to attempt retrying failed requests. Additionally, Directors have a quorum setting which can be used to determine when the Director as a whole is considered "up", in order to prevent "server whack-a-mole" following an outage as servers come back up. Only directors created via the API can be modified via the API. Directors known as "autodirectors" that are created automatically when load balancing groups of servers together cannot be modified or retrieved via the API.

A pool is responsible for balancing requests among a group of servers. In addition to balancing, pools can be configured to attempt retrying failed requests. Pools have a quorum setting that can be used to determine when the pool as a whole is considered up, in order to prevent problems following an outage as servers come back up.

A server is an address (IP address or hostname) to which the Fastly Load Balancer service can forward requests. This service can define multiple servers and assign it to a pool. Fastly can then select any one of these servers based on a selection policy defined for the pool.

Fastly will upload log messages to the Azure Blob Storage container in the format specified in the Azure Blob object.

Fastly will upload log messages to the Google BigQuery dataset and table in the format specified in the BigQuery logging object.

Fastly will upload log messages to your Rackspace Cloud Files account.

Fastly will upload log messages to Datadog in the format specified in the Datadog configuration object.

Fastly will upload log messages to the DigitalOcean Space in the format specified in the DigitalOcean Spaces object.

Fastly will upload log messages periodically to the server in the format specified in the Elasticsearch object.

Fastly will upload log messages periodically to the server in the format specified in the FTP object.

Fastly will upload log messages to the GCS bucket in the format specified in the GCS object.

Fastly will publish log messages to a Google Cloud Pub/Sub topic in the format specified in the Pub/Sub logging object.

Fastly will upload log messages to Grafana Cloud Logs.

Fastly will stream log messages to the Heroku account in the format specified in the Heroku object.

Fastly will upload log messages to Honeycomb.io in the format specified in the Honeycomb object.

Fastly will upload log messages to an HTTPS endpoint in the format specified in the HTTPS object. The HTTPS endpoint requires proof of domain ownership before logs can be received. Learn how to validate your domain in our HTTPS endpoint documentation.

Fastly will upload log messages periodically to the server in the format specified in the Kafka object.

Fastly will publish log messages to an Amazon Kinesis stream in the format specified in the Amazon Kinesis Data Streams logging object.

Fastly will stream log messages to the Loggly account in the format specified in the Loggly logging object.

Fastly will upload log messages to the Log Shuttle bucket in the format specified in the logshuttle object.

Fastly will upload log messages to New Relic Logs in the format specified in the New Relic configuration object.

Allows OTLP trace data to be sent to New Relic. Requires custom VCL to instrument the service to generate OTLP trace data. See https://docs.fastly.com/en/guides/log-streaming-newrelic-otlp#instrumenting-your-vcl-service for details.

Fastly will upload log messages to the OpenStack bucket in the format specified in the openstack object.

Fastly will stream log messages to the Papertrail account in the format specified in the Papertrail object.

Fastly will upload log messages to the S3 bucket in the format specified in the S3 object.

Fastly will stream log messages to the Scalyr account in the format specified in the Scalyr object.

Fastly will upload log messages periodically to the server in the format specified in the SFTP object.

Fastly will POST messages to your Splunk account in the format specified in the Splunk object.

Fastly will POST messages to the Sumo Logic account in the format specified in the Sumologic object.

Fastly will stream log messages to the location in the format specified in the Syslog object.

Domain Inspector provides a JSON-formatted historical API for visibility into responses delivered from your domains by Fastly. The API offers a standardized set of data to report in minutely, hourly, or daily granularity on every domain response, byte, and status code received by a specified service.

The real-time domain metrics API allows you to programmatically retrieve per-domain delivery metrics derived from your Fastly services in one-second periods up to the last complete second.

The Historical Stats API allows you to programmatically retrieve historical caching statistics derived from your Fastly services. You can use these metrics to help you optimize your site’s data caching and analyze your site’s traffic.

Origin Inspector provides a JSON-formatted historical API for visibility into responses delivered from your origin servers to Fastly. The API offers a standardized set of data to report in minutely, hourly or daily granularity on every origin response, byte, and status code received by a specified service.

Origin Inspector offers a real-time JSON-formatted data stream providing visibility into responses delivered from your origin servers to Fastly. The API offers a standardized set of data to report in real-time every origin response, byte, and status code received by a specified service in one-second periods up to the last complete second.

The real-time analytics API offers a standardized set of data about traffic received by a specified service in one-second time periods up to the last complete second.

Stats give you information on the usage and performance of your Service. They can be requested by Service and over a particular time span. Stats are broken down per POP, giving you information on how your Services are being used across the world. There is now a more flexible, and fully featured Stats API available.

Definitions are used to configure alerts on how to observe a metric.

Alerts history presents the past event notifications sent when observed metrics thresholds were triggered.

The Observability API allows you to programmatically define custom dashboards to view in the Observability web interface.

The Insights API allows users to analyze insights from sampled logs that are collected for the Log Explorer & Insights product.

The Log Explorer API allows users to query the sampled logs that are collected for the Log Explorer & Insights product.

The Notification Service API allows you to programmatically create and manage notification integrations. Fastly will use these integrations to send you notifications and alerts related to the Fastly product. Mailing list, Microsoft Teams, New Relic, Slack, PagerDuty, and webhook are supported as integrations.

These endpoints allow you to enable, disable, configure, and check the enablement status of products on your services.

Publishing sends messages to Fanout subscribers. Fanout is designed to be GRIP-compatible, such that https://api.fastly.com/service/{service_id} can be used as a GRIP URL in application configurations.

Instant Purging removes content from Fastly immediately so it can be refreshed from your origin servers. While the default approach for issuing an individual URL Instant Purge uses the Fastly API, https://api.fastly.com/, it is not required.

Security API allows you to manage workspaces, requests, events, redactions, tags, and rules.

A backend (also sometimes called an origin server) is a server identified by IP address or hostname, from which Fastly will fetch your content. There can be multiple backends attached to a service, but each backend is specific to one service. By default, the first backend added to a service configuration will be used for all requests (provided it meets any conditions attached to it). If multiple backends are defined for a service, the first one that has no attached conditions, or whose conditions are satisfied for the current request, will be used, unless that behavior is modified using the auto_loadbalance field described below.

A domain represents the domain name through which visitors will retrieve content. There can be multiple domains for a service.

Health checks are used to customize the way Fastly checks on your Backends. If an origin server is marked unhealthy due to health checks, Fastly will stop attempting to send requests to it. If all origin servers are marked unhealthy, Fastly will attempt to serve stale. If no stale object is available, a 503 will be returned to the client.

Configures default settings for Fastly Image Optimizer requests, configuring the way images are optimized when not overridden by URL parameters on specific requests.

Fastly Compute is a computation platform capable of running custom binary packages that you compile on your own systems and upload to Fastly. These packages are associated with a service version and are deployed to Fastly's edge network.

A resource link represents a link between a shared resource (such as an kv store or config store) and a service version.

A container that lets you store data in key-value pairs. Learn more about config stores.

A key-value pair within a config store. Learn more about config stores.

A KV store is a persistent, globally consistent key-value store accessible to Compute services during request processing. Learn more about KV stores.

An item in an kv store. Learn more about KV stores.

A secret store is a persistent, globally distributed store for secrets accessible to Compute services during request processing. Learn more about secret stores.

A secret within a secret store. Learn more about secret stores.

A Service represents the configuration for a website, app, API, or anything else to be served through Fastly. A Service can have many Versions, through which Backends, Domains, and more can be configured.

A Version represents a specific instance of the configuration for a service. A Version can be cloned, locked, activated, or deactivated.

Customers with access to multiple sets of IP pools are able to apply different configuration options to their TLS enabled domains.

TLS activations.

A TLS certificate is used to terminate TLS traffic for one or more of your TLS domains.

A certificate signing request is needed to obtain a TLS certificate from a Certificate Authority (CA).

TLS domains are all the domains (including wildcard domains) included in any TLS certificate's Subject Alternative Names (SAN) list. Included in the response is information about which certificates reference this domain as well as the TLS activation indicating which certificate is enabled to serve TLS traffic for the domain.

A private key is used to sign a Certificate. A key can be used to sign multiple certificates.

Mutual TLS can be added to existing TLS activations to allow for client-to-server authentication. In order to use mutual TLS, you must already have active server-side TLS using either custom certificates or an enabled Fastly-managed subscription.

The Mutual TLS API allows for client-to-server authentication using client-side X.509 authentication. The main Mutual Authentication object represents the certificate bundle and other configurations which support Mutual TLS for your domains.

Available to Platform TLS customers, these endpoints streamline the upload, deployment and management of large numbers of TLS certificates. A certificate is used to terminate TLS traffic for one or more of your fully qualified domain names (domains). Uploading a new certificate automatically enables TLS for all domains listed as Subject Alternative Names (SAN entries) on the certificate.

The TLS subscriptions API allows you to programmatically generate TLS certificates that are procured and renewed by Fastly. Once a subscription is created for a given hostname or wildcard domain, DNS records are checked to ensure that the domain on the subscription is owned by the subscription creator. Provided DNS records are maintained, TLS certificates will automatically renew. If Fastly is unable to issue a certificate, we will retry to issue the certificate for 7 days past subscription creation or the latest certificate's not_after date, whichever is later. If after 7 days Fastly is unable to issue a certificate, the subscription state will change to failed and Fastly will stop retrying.

Fastly makes it possible to see which version of a particular URL is cached on each edge server.

See the line-by-line changes in configuration between two different versions of a service.

Documentation of the endpoints that return the Fastly API Documentation.

List Fastly POPs and their locations.

To help you manage firewall rules for connections from Fastly to your origin, we provide access to the list of Fastly's assigned IP ranges. Changes to this list will be announced in advance as an "IP address announcement" along with other service announcements to our status page, which you can subscribe to. This list is exhaustive and includes all Fastly-owned IP ranges, so any client connections, log streaming reports, and origin connections should use these addresses.

Sudo mode allows users to perform privileged actions after going through a re-authentication flow.

Supports redirecting traffic for apex domains, subdomains, or wildcard domains to a WWW subdomain.

Configures cache lifetime for objects stored in the Fastly cache, overriding cache freshness information that would otherwise be determined from cache-related headers on the HTTP response. When used in conjunction with conditions, cache settings objects provide detailed control over how long content persists in the cache.

Conditions are used to control whether logic defined in configured VCL objects is applied for a particular client request. A condition contains a VCL conditional expression that evaluates to either true or false and is used to determine whether the condition is met. The type of the condition determines where it is executed and the VCL variables that can be evaluated as part of the conditional logic.

Compare the changes in generated VCL between two versions of a service. This is sometimes called a "diff" because the comparison may highlight "differences" between the versions. To compare the configuration changes between two versions of a service represented in YAML format instead, use the related diff endpoint.

Gzip configuration allows you to choose resources to automatically compress. For more information about compressing and decompressing data with Fastly, check out our concept guide to compression.

Header objects are used to add, modify, or delete headers from requests and responses. The header content can be simple strings or be derived from variables inside Varnish. Regular expressions can be used to customize the headers even further.

Supports the use of the HTTP/3 (QUIC) protocol.

Rate limiters add configurable origin request rate limiting to a service. This information is part of a limited availability release. For more information, see our product and feature lifecycle descriptions. To use this feature you must purchase a Professional or Premier Platform subscription for either Signal Sciences Cloud WAF or Signal Sciences Next-Gen WAF and have a paid account with a contract for full-site delivery.

Settings used to customize Fastly's request handling. When used with Conditions the Request Settings object allows you to fine tune how specific types of requests are handled.

Allows you to create synthetic responses that exist entirely on the varnish machine. Useful for creating error or maintenance pages that exists outside the scope of your backend architecture. Best when used with Condition objects.

Handles default settings for a particular version of a service.

VCL Snippets are blocks of VCL logic inserted into your service's configuration that don't require custom VCL.

A VCL is a Varnish configuration file used to customize the configuration for a Service.

A firewall represents a configuration of a Web Application Firewall (WAF) on a service. A firewall has many firewall versions through which you can manage rules.

Firewall version objects contain all of the rules and settings for your WAF and remain empty until properly configured. To understand the behavior of thresholds and scores, see Managing rules. Newly created firewall versions are initiated without any associated rules. See Active Rules for details. Changes to your WAF's rules and settings can be made by cloning an existing firewall version, making the changes, and then activating the new firewall version.

Rules are universally available for every firewall. Rules can have one or multiple rule revisions. You can add rules to your firewall by creating active rules.

An active rule represents a rule revision added to a particular firewall version.

WAF rule exclusions provide a flexible way to handle false positives, allowing specific variables, rules, and the entire WAF to be excluded on a per request basis. You can configure up to 300 WAF exclusions and each exclusion of type rule can have up to 30 rules associated with it.

Rule revisions track new variations of rules as they change over time with enhancements, fixes, and improvements. This object allows you to find a specific variation of a rule for use in your application. An active rule on a firewall uses a specific rule revision.

Tags for categorizing WAF rules.