Index of all API Endpoints

This page contains a categorized list of the API endpoints provided by Fastly, all in one place. Click an endpoint or use the links below each heading to jump to the reference material for that item.

Billing

Billing

Get information on current and past bills.

Billing address

Billing address

A billing address is used to calculate your bill correctly.
ActionEndpoint
Get a billing address
Add a billing address to a customer
Delete a billing address
Update a billing address

Customer Contact

Customer Contact

A Customer Contact is the base object that holds the different types of contact information Fastly uses to contact a customer.
ActionEndpoint
List contacts
Add a new customer contact
Delete a contact

Customer

Customer

A Customer is the base object that owns your Users and Services. Some information may be limited depending on access level.
ActionEndpoint
List users
Get the logged in customer
Get a customer
Update a customer
Delete a customer

Event logs

Event logs

Event logs are used to audit actions performed by customers.
ActionEndpoint
List events
Get an event

Invitations

Invitations

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.
ActionEndpoint
List invitations
Create an invitation
Delete an invitation

Permissions

Permissions

A list of available permissions that can be assigned to a custom role.
ActionEndpoint
List permissions

Roles

Roles

A role is a collection of permissions that can be assigned to a user group.
ActionEndpoint
List roles
Create a role
POST/roles
Get a role
Delete a role
Update a role
List permissions in a role
Add permissions to a role
Remove permissions from a role

Service authorizations

Service authorizations

A service authorization allows limited users to access only specified services.
ActionEndpoint
Show service authorization
Delete service authorization
Update service authorization
List service authorizations
Create service authorization
Delete service authorizations
Update service authorizations

Service Groups

Service Groups

A service group is a collection of services that can be assigned to a user group.
ActionEndpoint
List service groups
Create a service group
Get a service group
Delete a service group
Update a service group
List services to a service group
Add services in a service group
Remove services from a service group

Star

Star

A star allows users to mark services of interest.
ActionEndpoint
Get a star
Delete a star
List stars
Create a star
POST/stars

User

User

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.
ActionEndpoint
Get the current user
Get a user
Update a user
Delete a user
Create a user
POST/user
Update the user's password
Request a password reset

user groups

user groups

A user group is a collection of users with service groups and roles.
ActionEndpoint
List user groups
Create a user group
Get a user group
Delete a user group
Update a user group
List roles in a user group
Add roles to a user group
Remove roles from a user group
List service groups in a user group
Add service groups to a user group
Remove service groups from a user group
List members of a user group
Add members to a user group
Remove members of a user group

ACL

ACL

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

ACL Entry

ACL Entry

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.

Authentication tokens

Authentication tokens

An API Token is used to identify who the API call is made on behalf of. It can also be used to restrict what an app can do through authorization scope. Users can create multiple tokens to suit their needs.
ActionEndpoint
List tokens for the authenticated user
Create a token
Revoke multiple tokens
DELETE/tokens
List tokens for a customer
Get the current token
Revoke the current token
Revoke a token

Dictionary

Dictionary

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

Dictionary info

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

Dictionary item

Dictionary item

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.
ActionEndpoint
List items in an edge dictionary
Update multiple entries in an edge dictionary
Get an item from an edge dictionary
Insert or update an entry in an edge dictionary
Delete an item from an edge dictionary
Update an entry in an edge dictionary
Create an entry in an edge dictionary

Configuration sets Deprecated

Configuration sets

Configuration sets are used to view and select the available versions of the Fastly WAF rules.
ActionEndpoint
List configuration setsDeprecated
List WAFs currently using a configuration setDeprecated
Apply a configuration set to a WAFDeprecated

Firewall Deprecated

Firewall

Firewall object used when configuring WAF.
ActionEndpoint
List firewallsDeprecated
Create a firewallDeprecated
Get a firewallDeprecated
Update a firewallDeprecated
Disable a firewallDeprecated
Enable a firewallDeprecated
List active firewallsDeprecated
Get a firewall objectDeprecated

OWASP Deprecated

OWASP

OWASP settings object used when configuring WAF.
ActionEndpoint
Get the OWASP settings objectDeprecated
Create an OWASP settings objectDeprecated
Update the OWASP settings objectDeprecated

Rules Deprecated

Rules

Rules used when configuring WAF.
ActionEndpoint
List rules in the latest configuration setDeprecated
Get a ruleDeprecated
Get VCL for a ruleDeprecated
Get VCL for a rule associated with a firewallDeprecated

Rule statuses Deprecated

Rule statuses

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.
ActionEndpoint
List rule statusesDeprecated
Create or update status of a tagged group of rulesDeprecated
Get the status of a rule on a firewallDeprecated
Update the status of a ruleDeprecated

Rule sets Deprecated

Rule sets

Retrieve the currently deployed WAF ruleset VCL and the date it was deployed.
ActionEndpoint
Get a WAF rulesetDeprecated
Update a WAF rulesetDeprecated
Generate WAF ruleset VCLDeprecated

Tags Deprecated

Tags

Tags for categorizing WAF rules. Tags can be filtered by name.
ActionEndpoint
List WAF tagsDeprecated

Update statuses Deprecated

Update statuses

Update status indicates the status of an asynchronous process for updating a firewall object.
ActionEndpoint
List update statusesDeprecated
Get the status of a WAF updateDeprecated

Director backend

Director backend

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.

Director

Director

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.

Pool

Pool

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.

Server

Server

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.

Microsoft Azure Blob Storage

Microsoft Azure Blob Storage

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

BigQuery

BigQuery

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

Cloud Files

Cloud Files

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

Datadog

Datadog

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

DigitalOcean Spaces

DigitalOcean Spaces

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

Elasticsearch

Elasticsearch

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

FTP

FTP

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

GCS Logging

GCS Logging

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

Google Cloud Pub/Sub Logging

Google Cloud Pub/Sub Logging

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

Heroku

Heroku

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

Honeycomb Logging

Honeycomb Logging

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

HTTPS

HTTPS

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.

Kafka

Kafka

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

Kinesis

Kinesis

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

Logentries

Logentries

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

Loggly

Loggly

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

Log Shuttle

Log Shuttle

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

New Relic Logs

New Relic Logs

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

OpenStack

OpenStack

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

Papertrail

Papertrail

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

S3

S3

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

Scalyr

Scalyr

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

SFTP

SFTP

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

Splunk

Splunk

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

Sumologic

Sumologic

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

Syslog

Syslog

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

Domain Inspector Historical API

Domain Inspector Historical API

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.
ActionEndpoint
Get historical domain data for a service

Domain Inspector Real-time API

Domain Inspector Real-time API

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.
ActionEndpoint
Get real-time domain data from a specified time
Get real-time domain data for the last 120 seconds
Get a limited number of real-time domain data entries

Historical Stats

Historical Stats

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.
ActionEndpoint
Get historical stats
Get historical stats for a single field
Get aggregated historical stats
Get historical stats for a single service
Get historical stats for a single service/field combination
Get usage statistics
Get usage statistics per service
Get month-to-date usage statistics
Get region codes

Origin insights

Origin insights

Origin insights is 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.
ActionEndpoint
Get real-time origin data from specified time
Get real-time origin data for the last 120 seconds
Get a limited number of real-time origin data entries

Origin Inspector Historical API

Origin Inspector Historical API

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.
ActionEndpoint
Get historical origin data for a service

Origin Inspector Real-time API

Origin Inspector Real-time API

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.
ActionEndpoint
Get real-time origin data from specific time
Get real-time origin data for the last 120 seconds
Get a limited number of real-time origin data entries

Real-time analytics

Real-time analytics

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.
ActionEndpoint
Get real-time data from specified time
Get real-time data for the last 120 seconds
Get a limited number of real-time data entries

Stats

Stats

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.
ActionEndpoint
Get stats for a service

Object store

Object store

An object store is a persistent, globally consistent key-value store accessible to Compute@Edge services during request processing.

Purging

Purging

Instant Purging removes content from Fastly immediately so it can be refreshed from your origin servers. The main entry point for the API, https://api.fastly.com/, is not needed for an individual URL Instant Purge.
ActionEndpoint
Purge a URL
PURGE/*
Purge everything from a service
Purge by surrogate key tag
Purge multiple surrogate key tags

Backend

Backend

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 condition is satisfied for the current request, will be used, unless that behavior is modified using the auto_loadbalance field described below.

Domain

Domain

A domain represents the domain name through which visitors will retrieve content. There can be multiple domains for a service.
ActionEndpoint
Validate DNS configuration for all domains on a service
Validate DNS configuration for a single domain on a service
List domains
Add a domain name to a service
Describe a domain
Update a domain
Remove a domain from a service

Domain ownerships

Domain ownerships

A domain ownership is the record that Fastly keeps after a customer has validated control over a domain.
ActionEndpoint
List domain-ownerships

Healthcheck

Healthcheck

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

Package

Package

Compute@Edge 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.
ActionEndpoint
Get details of the service's Compute@Edge package
Upload a Compute@Edge package

Resource

Resource

A resource represents a link between a resource type and a service version.

Service

Service

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.
ActionEndpoint
List services
Create a service
Get service details
Search for a service by name
Get a service
Update a service
Delete a service
List the domains within a service

Version

Version

A Version represents a specific instance of the configuration for a service. A Version can be cloned, locked, activated, or deactivated.
ActionEndpoint
List versions of a service
Create a service version
Get a version of a service
Update a service version
Validate a service version
Activate a service version
Deactivate a service version
Clone a service version
Lock a service version

TLS Configuration

TLS Configuration

Customers with access to multiple sets of IP pools are able to apply different configuration options to their TLS enabled domains.
ActionEndpoint
List TLS configurations
Get a TLS configuration
Update a TLS configuration

TLS Activations

TLS Activations

TLS activations.
ActionEndpoint
List TLS activations
Enable TLS for a domain using a custom certificate
Get a TLS activation
Disable TLS on a domain
Update a certificate

TLS Certificates

TLS Certificates

A TLS certificate is used to terminate TLS traffic for one or more of your TLS domains.
ActionEndpoint
List TLS certificates
Create a TLS certificate
Get a TLS certificate
Delete a TLS certificate
Update a TLS certificate

TLS Domains

TLS Domains

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.
ActionEndpoint
List TLS domains

Private Keys

Private Keys

A private key is used to sign a Certificate. A key can be used to sign multiple certificates.
ActionEndpoint
List TLS private keys
Create a TLS private key
Get a TLS private key
Delete a TLS private key

Setting and Unsetting Mutual TLS on TLS Activations

Setting and Unsetting Mutual TLS on TLS Activations

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.
ActionEndpoint
List TLS activations
Get a TLS activation
Update Mutual TLS

Managing and Uploading Mutual Authentications

Managing and Uploading Mutual Authentications

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.
ActionEndpoint
List Mutual Authentications
Create a Mutual Authentication
Get a Mutual Authentication
Delete a Mutual TLS

Bulk Certificates

Bulk Certificates

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.
ActionEndpoint
List certificates
Upload a certificate
Get a certificate
Delete a certificate
Update a certificate

TLS Subscriptions

TLS Subscriptions

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.

Check content status

Check content status

Fastly makes it possible to see which version of a particular URL is cached on each edge server.
ActionEndpoint
Check status of content in each POP's cache

Diff

Diff

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

Docs Deprecated

Docs

Documentation of the endpoints that return the Fastly API Documentation.
ActionEndpoint
Get Fastly API docs as structured dataDeprecated
Get API docs for a single subjectDeprecated
Get API docs matching a section filterDeprecated

POPs

POPs

List Fastly POPs and their locations.
ActionEndpoint
List Fastly POPs

Public IP List

Public IP List

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" (example) 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.
ActionEndpoint
List Fastly's public IPs

Apex redirect

Apex redirect

Supports redirecting traffic for apex domains, subdomains, or wildcard domains to a WWW subdomain.
ActionEndpoint
List apex redirects
Create an apex redirect
Get an apex redirect
Update an apex redirect
Delete an apex redirect

Cache settings

Cache settings

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.

Condition

Condition

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.

VCL Diff

VCL Diff

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.
ActionEndpoint
Get a comparison of the VCL changes between two service versions

Gzip

Gzip

Gzip configuration allows you to choose resources to automatically compress.

Header

Header

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.

Rate Limiter

Rate Limiter

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 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.
ActionEndpoint
List rate limiters
Create a rate limiter
Get a rate limiter
Update a rate limiter
Delete a rate limiter

Request settings

Request settings

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.

Response object

Response object

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.

Settings

Settings

Handles default settings for a particular version of a service.
ActionEndpoint
Get service settings
Update service settings

VCL Snippets

VCL Snippets

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

VCL

VCL

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

Firewalls Deprecated

Firewalls

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.
ActionEndpoint
List firewallsDeprecated
Create a firewallDeprecated
Get a firewallDeprecated
Delete a firewallDeprecated
Update a firewallDeprecated

Firewall versions Deprecated

Firewall versions

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.
ActionEndpoint
List firewall versionsDeprecated
Create a firewall versionDeprecated
Get a firewall versionDeprecated
Update a firewall versionDeprecated
Clone a firewall versionDeprecated
Deploy or activate a firewall versionDeprecated

Rules Deprecated

Rules

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.
ActionEndpoint
List available WAF rulesDeprecated
Get a ruleDeprecated

Active Rules Deprecated

Active Rules

An active rule represents a rule revision added to a particular firewall version.
ActionEndpoint
List active rules on a WAFDeprecated
Add a rule to a WAF as an active ruleDeprecated
Delete multiple active rules from a WAFDeprecated
Get an active WAF rule objectDeprecated
Delete an active ruleDeprecated
Update an active ruleDeprecated
Update multiple active rulesDeprecated
Create active rules by tagDeprecated

WAF Rule Exclusions Deprecated

WAF Rule Exclusions

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 Deprecated

Rule revisions

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.
ActionEndpoint
List revisions for a ruleDeprecated
Get a revision of a ruleDeprecated

Tags Deprecated

Tags

Tags for categorizing WAF rules.
ActionEndpoint
List tagsDeprecated