Jump To Close Expand all Collapse all Table of contents Data Grid REST API Red Hat Data Grid Expand section "Red Hat Data Grid" Collapse section "Red Hat Data Grid" Data Grid documentation Data Grid downloads Making open source more inclusive 1. Data Grid REST Endpoint Expand section "1. Data Grid REST Endpoint" Collapse section "1. Data Grid REST Endpoint" 1.1. REST Authentication 1.2. Supported Protocols 1.3. Data Formats and the REST API Expand section "1.3. Data Formats and the REST API" Collapse section "1.3. Data Formats and the REST API" 1.3.1. Supported Formats 1.3.2. Accept Headers 1.3.3. Names with Special Characters 1.3.4. Key-Content-Type Headers 1.3.5. JSON/Protostream Conversion 1.4. Cross-Origin Resource Sharing (CORS) Requests Expand section "1.4. Cross-Origin Resource Sharing (CORS) Requests" Collapse section "1.4. Cross-Origin Resource Sharing (CORS) Requests" 1.4.1. Allowing all CORS permissions for some origins 2. Interacting with the Data Grid REST API Expand section "2. Interacting with the Data Grid REST API" Collapse section "2. Interacting with the Data Grid REST API" 2.1. Creating and Managing Caches Expand section "2.1. Creating and Managing Caches" Collapse section "2.1. Creating and Managing Caches" 2.1.1. Creating Caches Expand section "2.1.1. Creating Caches" Collapse section "2.1.1. Creating Caches" 2.1.1.1. Cache configuration 2.1.2. Modifying Caches 2.1.3. Verifying Caches 2.1.4. Creating Caches with Templates 2.1.5. Retrieving Cache Configuration 2.1.6. Converting Cache Configurations between XML, JSON and YAML 2.1.7. Retrieving All Cache Details 2.1.8. Retrieving all mutable cache configuration attributes 2.1.9. Updating cache configuration attributes 2.1.10. Adding Entries 2.1.11. Replacing Entries 2.1.12. Retrieving Data By Keys 2.1.13. Checking if Entries Exist 2.1.14. Deleting Entries 2.1.15. Deleting Caches 2.1.16. Retrieving All Keys from Caches 2.1.17. Retrieving All Entries from Caches 2.1.18. Clearing Caches 2.1.19. Getting Cache Size 2.1.20. Getting Cache Statistics 2.1.21. Listing Caches 2.1.22. Listening to cache events 2.1.23. Enabling rebalancing 2.1.24. Disabling rebalancing 2.1.25. Getting Cache Availability 2.1.26. Setting Cache Availability 2.1.27. Indexing and Querying with the REST API Expand section "2.1.27. Indexing and Querying with the REST API" Collapse section "2.1.27. Indexing and Querying with the REST API" 2.1.27.1. Re-indexing Data 2.1.27.2. Purging Indexes 2.1.27.3. Retrieving Query and Index Statistics 2.1.27.4. Clearing Query Statistics 2.1.27.5. Retrieving Index Statistics (Deprecated) 2.1.27.6. Retrieving Query Statistics (Deprecated) 2.1.27.7. Clearing Query Statistics (Deprecated) 2.1.28. Cross-Site Operations with Caches Expand section "2.1.28. Cross-Site Operations with Caches" Collapse section "2.1.28. Cross-Site Operations with Caches" 2.1.28.1. Getting status of all backup locations 2.1.28.2. Getting status of specific backup locations 2.1.28.3. Taking backup locations offline 2.1.28.4. Bringing backup locations online 2.1.28.5. Pushing state to backup locations 2.1.28.6. Canceling state transfer 2.1.28.7. Getting state transfer status 2.1.28.8. Clearing state transfer status 2.1.28.9. Modifying take offline conditions 2.1.28.10. Canceling state transfer from receiving sites 2.1.29. Rolling Upgrades Expand section "2.1.29. Rolling Upgrades" Collapse section "2.1.29. Rolling Upgrades" 2.1.29.1. Connecting Source Clusters 2.1.29.2. Obtaining Source Cluster connection details 2.1.29.3. Checking if a Cache is connected 2.1.29.4. Synchronizing Data 2.1.29.5. Disconnecting Source Clusters 2.2. Creating and Managing Counters Expand section "2.2. Creating and Managing Counters" Collapse section "2.2. Creating and Managing Counters" 2.2.1. Creating Counters 2.2.2. Deleting Counters 2.2.3. Retrieving Counter Configuration 2.2.4. Getting Counter Values 2.2.5. Resetting Counters 2.2.6. Incrementing Counters 2.2.7. Adding Deltas to Counters 2.2.8. Decrementing Counter Values 2.2.9. Performing compareAndSet Operations on Strong Counters 2.2.10. Performing compareAndSwap Operations on Strong Counters 2.2.11. Listing Counters 2.3. Working with Protobuf Schemas Expand section "2.3. Working with Protobuf Schemas" Collapse section "2.3. Working with Protobuf Schemas" 2.3.1. Creating Protobuf Schemas 2.3.2. Reading Protobuf Schemas 2.3.3. Updating Protobuf Schemas 2.3.4. Deleting Protobuf Schemas 2.3.5. Listing Protobuf Schemas 2.4. Working with Cache Managers Expand section "2.4. Working with Cache Managers" Collapse section "2.4. Working with Cache Managers" 2.4.1. Getting Basic Cache Manager Information 2.4.2. Getting Cluster Health 2.4.3. Getting Cache Manager Health Status 2.4.4. Checking REST Endpoint Availability 2.4.5. Obtaining Global Configuration for Cache Managers 2.4.6. Obtaining Configuration for All Caches 2.4.7. Listing Available Cache Templates 2.4.8. Obtaining Cache Status and Information 2.4.9. Getting Cache Manager Statistics 2.4.10. Shutdown all container caches 2.4.11. Enabling rebalancing for all caches 2.4.12. Disabling rebalancing for all caches 2.4.13. Backing Up Data Grid Cache Managers 2.4.14. Listing Backups 2.4.15. Checking Backup Availability 2.4.16. Downloading Backup Archives 2.4.17. Deleting Backup Archives 2.4.18. Restoring Data Grid Resources from Backup Archives Expand section "2.4.18. Restoring Data Grid Resources from Backup Archives" Collapse section "2.4.18. Restoring Data Grid Resources from Backup Archives" 2.4.18.1. Restoring from Backup Archives on Data Grid Server 2.4.18.2. Restoring from Local Backup Archives 2.4.19. Listing Restores 2.4.20. Checking Restore Progress 2.4.21. Deleting Restore Metadata 2.4.22. Listening to container configuration events 2.4.23. Cross-Site Operations with Cache Managers Expand section "2.4.23. Cross-Site Operations with Cache Managers" Collapse section "2.4.23. Cross-Site Operations with Cache Managers" 2.4.23.1. Getting status of backup locations 2.4.23.2. Taking backup locations offline 2.4.23.3. Bringing backup locations online 2.4.23.4. Retrieving the state transfer mode 2.4.23.5. Setting the state transfer mode 2.4.23.6. Starting state transfer 2.4.23.7. Canceling state transfer 2.5. Working with Data Grid Servers Expand section "2.5. Working with Data Grid Servers" Collapse section "2.5. Working with Data Grid Servers" 2.5.1. Retrieving Basic Server Information 2.5.2. Getting Cache Managers 2.5.3. Adding Caches to Ignore Lists 2.5.4. Removing Caches from Ignore Lists 2.5.5. Confirming Ignored Caches 2.5.6. Obtaining Server Configuration 2.5.7. Getting Environment Variables 2.5.8. Getting JVM Memory Details 2.5.9. Getting JVM Thread Dumps 2.5.10. Getting Diagnostic Reports for Data Grid Servers 2.5.11. Stopping Data Grid Servers 2.6. Working with Data Grid Clusters Expand section "2.6. Working with Data Grid Clusters" Collapse section "2.6. Working with Data Grid Clusters" 2.6.1. Stopping Data Grid Clusters 2.6.2. Stopping Specific Data Grid Servers in Clusters 2.6.3. Backing Up Data Grid Clusters 2.6.4. Listing Backups 2.6.5. Checking Backup Availability 2.6.6. Downloading Backup Archives 2.6.7. Deleting Backup Archives 2.6.8. Restoring Data Grid Cluster Resources Expand section "2.6.8. Restoring Data Grid Cluster Resources" Collapse section "2.6.8. Restoring Data Grid Cluster Resources" 2.6.8.1. Restoring from Backup Archives on Data Grid Server 2.6.8.2. Restoring from Local Backup Archives 2.6.9. Listing Restores 2.6.10. Checking Restore Progress 2.6.11. Deleting Restore Metadata 2.7. Data Grid Server logging configuration Expand section "2.7. Data Grid Server logging configuration" Collapse section "2.7. Data Grid Server logging configuration" 2.7.1. Listing the logging appenders 2.7.2. Listing the loggers 2.7.3. Creating/modifying a logger 2.7.4. Removing a logger 2.8. Using Server Tasks Expand section "2.8. Using Server Tasks" Collapse section "2.8. Using Server Tasks" 2.8.1. Retrieving Server Tasks Information 2.8.2. Executing Tasks 2.8.3. Uploading Script Tasks 2.9. Working with Data Grid Security Expand section "2.9. Working with Data Grid Security" Collapse section "2.9. Working with Data Grid Security" 2.9.1. Retrieving the ACL of a user 2.9.2. Flushing the ACL cache 2.9.3. Retrieving the available roles 2.9.4. Retrieving the roles for a principal 2.9.5. Granting roles to a principal 2.9.6. Denying roles to a principal Legal Notice Settings Close Language: 简体中文 日本語 English Language: 简体中文 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 简体中文 日本語 English Language: 简体中文 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Data Grid documentation Documentation for Data Grid is available on the Red Hat customer portal. Data Grid 8.3 Documentation Data Grid 8.3 Component Details Supported Configurations for Data Grid 8.3 Data Grid 8 Feature Support Data Grid Deprecated Features and Functionality Previous Next