graphql_caching

Property Manager name: GraphQL Caching
Behavior version: The v2025-01-13 rule format supports the graphql_caching behavior v1.1.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

This behavior configures how to cache GraphQL-based API traffic. Enable caching for your GraphQL API traffic, along with allow_post to cache POST responses. To configure REST API traffic, use the rapid behavior.

Option	Type	Description
`enabled`	boolean	Enables GraphQL caching.	{"displayType":"boolean","tag":"input","type":"checkbox"}
`cache_responses_with_errors`	boolean	When enabled, caches responses that include an `error` field at the top of the response body object. Disable this if your GraphQL server yields temporary errors with success codes in the 2xx range.	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`post_request_processing_error_handling`	enum	Specify what happens if GraphQL query processing fails on POST requests.	{"displayType":"enum","options":["APPLY_CACHING_BEHAVIOR","NO_STORE"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`APPLY_CACHING_BEHAVIOR`	If your GraphQL server does not allow mutations and subscriptions, this offloads requests.
	`NO_STORE`	Pass requests to the origin.
`operations_url_query_parameter_name`	string	Specifies the name of a query parameter that identifies requests as GraphQL queries.	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`operations_json_body_parameter_name`	string	The name of the JSON body parameter that identifies GraphQL POST requests.	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}

Updated about 1 month ago