GraphQL Proxy Caching Advanced API reference

You are browsing unreleased documentation.

Managing cache entities

The GraphQL Proxy Cache Advanced plugin exposes several endpoints for cache management. They are available through the Kong Admin API.

To configure and enable the plugin itself, use the /plugins API endpoint. The /graphql-proxy-cache-advanced endpoints only appear once the plugin has been enabled.

This plugin’s API endpoints are not available in hybrid mode. The data that this API targets is located on the data planes, and data planes can’t use the Kong Admin API.

Retrieve a cache entity

Two endpoints are available: one to look up a known plugin instance, and another that searches all graphql-proxy-cache-advanced plugins data stores for the given cache key. Both endpoints have the same return value.

Endpoint

Endpoint

Response

If the cache entity exists:

HTTP 200 OK

If the entity with the given key does not exist:

HTTP 400 Not Found

Delete cache entity

Two endpoints are available: one to look up a known plugin instance, and another that searches all graphql-proxy-cache-advanced plugins’ data stores for the given cache key. Both endpoints have the same return value.

Endpoint

Endpoint

Response

If the cache entity exists:

HTTP 204 No Content

If the entity with the given key does not exist:

HTTP 400 Not Found

Purge all cache entities

This endpoint purges all cache entities across all graphql-proxy-cache-advanced plugin instances.

Endpoint

Response

HTTP 204 No Content