Skip to content

[TT-15683] Added docs for Dashboard API JWKS cache flush endpoint #1021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

[TT-15683] Added docs for Dashboard API JWKS cache flush endpoint #1021

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
947f090
Added docs for Dashboard API endpoint
andyo-tyk Nov 25, 2025
121ccc2
Merge main into tt-15683-jwks-cache
buger Nov 26, 2025
4450ec3
Merge main into tt-15683-jwks-cache
buger Nov 26, 2025
0c6ddd8
Merge main into tt-15683-jwks-cache
buger Nov 26, 2025
87bfd1b
Merge main into tt-15683-jwks-cache
buger Nov 26, 2025
c41999f
Merge main into tt-15683-jwks-cache
buger Nov 26, 2025
87492e6
Merge main into tt-15683-jwks-cache
buger Nov 26, 2025
e81db38
Update api-management/authentication/jwt-signature-validation.mdx
sharadregoti Nov 27, 2025
482ddf3
Merge main into tt-15683-jwks-cache
buger Nov 27, 2025
671f359
Merge main into tt-15683-jwks-cache
buger Dec 1, 2025
fd91c2c
Merge main into tt-15683-jwks-cache
buger Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions api-management/authentication/jwt-signature-validation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,24 +228,31 @@ Tyk Classic APIs continue to use the existing JWKS caching behavior with the 240

### JWKS Cache Management

New [Gateway API](/tyk-gateway-api) endpoints are available from **Tyk 5.10.0** to manage JWKS caches programmatically. These endpoints work for both Tyk OAS and Tyk Classic APIs:
Tyk Gateway and Dashboard APIs expose endpoints to manage JWKS caches programmatically for both Tyk OAS and Tyk Classic APIs:

| Endpoint | Method | Description |
| ------------------------- | -------- | ---------------------------------------- |
| `/tyk/cache/jwks` | `DELETE` | Invalidate JWKS caches for all APIs |
| `/tyk/cache/jwks/{apiID}` | `DELETE` | Invalidate JWKS cache for a specific API |
| Endpoint | Method | Description | Availability |
| ------------------------- | -------- | ---------------------------------------- | ------------ |
| `/tyk/cache/jwks` | `DELETE` | Invalidate JWKS caches for all APIs | Tyk 5.10.0+ |
| `/tyk/cache/jwks/{apiID}` | `DELETE` | Invalidate JWKS cache for a specific API | Tyk 5.10.0+ |
| `/api/cache/jwks/{apiID}` | `DELETE` | Invalidate JWKS cache for a specific API on all connected Gateways | Tyk 5.11.0+ |

**Note:** These endpoints are currently available only through the Tyk [Gateway API](/tyk-gateway-api) and are not yet extended to the Tyk [Dashboard API](/tyk-dashboard-api).
<Note>
The Dashboard API endpoint is restricted to users with `admin` privileges and can only be used to flush the cache for APIs in the user's [Organisation](/tyk-dashboard-api#organisations%2C-apis-and-users).
</Note>

**Example usage:**
```bash
# Flush all JWKS caches
curl -X DELETE http://your-gateway:8080/tyk/cache/jwks \
-H "x-tyk-authorization: your-secret"
-H "x-tyk-authorization: your-gateway-secret"

# Flush JWKS cache for specific API
curl -X DELETE http://your-gateway:8080/tyk/cache/jwks/your-api-id \
-H "x-tyk-authorization: your-secret"
-H "x-tyk-authorization: your-gateway-secret"

# Flush JWKS cache for specific API on all connected Gateways
curl -X DELETE http://your-dashboard:8080/api/cache/jwks/your-api-id \
-H "authorization: your-dashboard-secret"
```

## FAQ
Expand Down