Clear cache

Clear specific application caches to force refresh of cached data and resolve performance issues

POST {baseUrlAdmin}/api/internal/cache/clear

cURL

curl -X POST '{{baseUrlAdmin}}/api/internal/cache/clear' \
  -H 'Authorization: Bearer <your-admin-token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cacheNames": [ 
      "flowx:core:cache"
    ]
  }'

Success (200)

{
  "status": "success",
  "message": "Caches cleared successfully",
  "clearedCaches": [
    "flowx:core:cache"
  ],
  "timestamp": "2024-01-15T10:30:00Z"
}

Reference under review. The path of this endpoint (/api/internal/...) indicates it is an internal admin operation, not part of the public integration API. For supported integration patterns, see Consuming FlowX from external apps.

This endpoint allows administrators to clear specific application caches within the FlowX platform. Cache clearing is typically used during maintenance, after configuration changes, or when troubleshooting performance issues that may be caused by stale cached data.

This operation can temporarily impact application performance as the system rebuilds cleared caches. Use during maintenance windows when possible.

This operation requires admin-level authentication and should only be performed by authorized system administrators.

baseUrlAdmin · string · required

The base URL of your FlowX Admin application. This is the admin interface endpoint where administrative operations are performed.

Example: https://admin.your-domain.com

Authorization · string · required

Bearer token for admin authentication. Must be a valid admin user token with cache management permissions.

Format: Bearer <your-admin-token>

Content-Type · string · required

Must be set to application/json for proper request processing.

cacheNames · array · required

Array of cache names to be cleared. Each cache name should be a valid string identifier for an existing cache in the system.

• flowx:core:cache - Core application cache

{
    "cacheNames": [
        "flowx:core:cache"
    ]
}

cURL

curl -X POST '{{baseUrlAdmin}}/api/internal/cache/clear' \
  -H 'Authorization: Bearer <your-admin-token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cacheNames": [ 
      "flowx:core:cache"
    ]
  }'

Response

status · string · required

Indicates the success or failure of the cache clearing operation.

• success - Cache clearing completed successfully
• error - Cache clearing failed

message · string

Optional descriptive message providing additional details about the operation result.

clearedCaches · array

Array of cache names that were successfully cleared. Only present in successful responses.

timestamp · string

ISO 8601 timestamp of when the operation was completed.

Success (200)

{
  "status": "success",
  "message": "Caches cleared successfully",
  "clearedCaches": [
    "flowx:core:cache"
  ],
  "timestamp": "2024-01-15T10:30:00Z"
}