Skip to content

Commit

Permalink
minor cleanup to moved api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lena-larionova committed Sep 23, 2024
1 parent 85485ef commit 2ec796e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 64 deletions.
63 changes: 1 addition & 62 deletions app/_src/gateway/production/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,68 +247,7 @@ restart will be required to discover any changes to the Cassandra cluster topolo

If for some reason, you want to investigate the cached values, or manually
invalidate a value cached by Kong (a cached hit or miss), you can do so via the
Admin API `/cache` endpoint.

{:.note}
> **Note**: Retrieving the `cache_key` for each entity being cached by Kong is
currently an undocumented process. Future versions of the Admin API will make
this process easier.

### Inspect a cached value

**Endpoint**

<div class="endpoint get">/cache/{cache_key}</div>

**Response**

If a value with that key is cached:

```
HTTP 200 OK
...
{
...
}
```

Else:

```
HTTP 404 Not Found
```

### Purge a cached value

**Endpoint**

<div class="endpoint delete">/cache/{cache_key}</div>

**Response**

```
HTTP 204 No Content
...
```

### Purge a node's cache

**Endpoint**

<div class="endpoint delete">/cache</div>

**Response**

```
HTTP 204 No Content
```

{:.note}
> **Note**: Be wary of using this endpoint on a node running in production with warm cache.
If the node is receiving a lot of traffic, purging its cache at the same time
will trigger many requests to your database, and could cause a
[dog-pile effect](https://en.wikipedia.org/wiki/Cache_stampede).

Admin API [`/cache`](/gateway/api/admin-ee/latest/#/) endpoint.

## Read more

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -593,8 +593,8 @@ and follow the instructions in Steps 1 and 2 **only** to download

## Verify that nodes are connected

Use the control plane’s Cluster Status API to monitor your data planes. It
provides:
Use the control plane’s [Cluster Status API](/gateway/api/admin-ee/latest/#/) to monitor your data planes.
It provides:
* The name of the node
* The last time the node synced with the control plane
* The version of the config currently running on each data plane
Expand Down

0 comments on commit 2ec796e

Please sign in to comment.