POST /_system/redis_keys

Create a new Redis key pattern configuration (requires setting_redis_keys permission)

Create a new Redis key pattern configuration (requires setting_redis_keys permission)
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
KeyTypeExampleDescription
keyrequiredstring
"user:{user_id}:session"
Redis key pattern (no spaces allowed)
{
  "_meta": {
    "created": 1782166695,
    "entity": 1,
    "guid": "a23575f49d0af385314c1f02280163374297e018a692e5e4ab85eb307ebf6ebc",
    "modified": 1782166695,
    "updated": 1782166695
  },
  "cache_hit_count": 0,
  "key": "user:{user_id}:session",
  "pins": [
    {}
  ]
}
{
  "error": "INSUFFICIENT_PERMISSIONS"
}
StatusError CodeDescription
401INSUFFICIENT_PERMISSIONSPermission or validation error
PermissionDescription
Bearer tokenAccess token required via Authorization header, x-authtoken, x-token, query param, or cookie
redis_keys_createRequired scope: redis_keys_create

Back to Redis Keys Return to the Redis Keys category to view other endpoints All API Categories Browse all available API categories