Caching

All Content APIs are served via our globally distributed edge cache. Whenever a query is sent to the content API, its response is cached in multiple POP (data centers) around the globe.

Hygraph CDN Map
Hygraph CDN Map

Hygraph handles all cache management for you! For faster queries, use GET requests, so browsers can leverage advanced caching abilities available in the headers.

Hygraph comes with two different content API endpoints, served by 2 different CDN providers. To understand which endpoint you should use, look at the following table.

Endpoint nameEndpointConsistencyAccess
Regular read & write endpointhttps://${region}.hygraph.com/v2/
${projectId}/${environment}
Eventual (Read-after-write within POP)Read & Write
High performance read-only endpointhttps://${region}.cdn.hygraph.com/v2/
${projectId}/${environment}
EventualRead-only

CDN = Content-Delivery-Network

You can see the endpoints in your project settings (Settings->API Access->Endpoints).

Regular read & write endpointAnchor

The Regular read & write endpoint allows for reads and writes. All your requests are cached, and any mutation will invalidate the cache for your project.

Even though this endpoint is eventually consistent, within a single region you will get read-after-write consistency.

This endpoint can take up to 30s to update all caching nodes worldwide.

This endpoint is ideal for delivering content around the globe with one endpoint, but it only has basic caching logic.

High performance read-only endpointAnchor

We use a state-of-the-art caching approach, and we have developed a high-performance edge service on the Fastly Compute Edge platform. The service is deployed close to your users around the world.

You will benefit from continual improvements on the cache invalidation logic without any code changes on your part.

This endpoint is ideal for delivering content around the globe with low latency and high read-throughput.

Writes are not allowed to our High performance endpoint. This means you should use the Regular read & write endpoint endpoint for mutations.

ConsistencyAnchor

To understand both endpoints better, you should have a basic knowledge of cache consistency modes. You can be sure that any changes have persisted at Hygraph if your response was successful.

Eventual ConsistencyAnchor

Some changes are not visible immediately after the update. For example, if you create, delete or update content the update is distributed around the globe with a short delay. Theoretically, if you read content right after a mutation, you may receive stale content.

Read-after-write consistencyAnchor

In contrast, read-after-write consistency guarantees that a subsequent read after an update, delete, or create can see those changes immediately. This is only valid for operations hitting the same POP (point-of-presence).

Smart cache invalidationAnchor

Our System understands if mutations are flowing through the cache and invalidates the affected resources with an eventual consistency guarantee.

Stale-if-errorAnchor

In case of an outage of our APIs - this includes remote field origin errors as well- we will fall back for at least 24h to the latest cached content on our edge servers. This adds an additional reliability layer.

This is only available on the High performance read-only endpoint.

Stale-while-revalidateAnchor

With the High performance read-only endpoint you will get cached responses directly, while we update the content in the background. This means your content is always served on the edge, with low latency for your users.

This is only available on the High performance read-only endpoint.

Remote fieldsAnchor

GraphQL queries that contain remote fields are cached differently. By default, a response is marked as cacheable when all remote field responses are cacheable according to rfc7234. You can control the TTL (Time-to-Live) cache by returning the Cache-Control response header.

By default, we will set a TTL of 900s, you can set a minimum TTL of 60s. While it is also possible to respond with a no-store cache directive to disable the cache, this is not recommended, as it marks the entire response as not cacheable and will increase the load on your origin.