Skip to navigation Skip to main content

Utilities

  • Subscriptions
  • Downloads
  • Containers
  • Support Cases
Red Hat Customer Portal
  • Subscriptions
  • Downloads
  • Containers
  • Support Cases
  • Products & Services

    Products

    Support

    • Production Support
    • Development Support
    • Product Life Cycles

    Services

    • Consulting
    • Technical Account Management
    • Training & Certifications

    Documentation

    • Red Hat Enterprise Linux
    • Red Hat JBoss Enterprise Application Platform
    • Red Hat OpenStack Platform
    • Red Hat OpenShift Container Platform
    All Documentation

    Ecosystem Catalog

    • Red Hat Partner Ecosystem
    • Partner Resources
  • Tools

    Tools

    • Troubleshoot a product issue
    • Packages
    • Errata

    Customer Portal Labs

    • Configuration
    • Deployment
    • Security
    • Troubleshoot
    All labs

    Red Hat Insights

    Increase visibility into IT operations to detect and resolve technical issues before they impact your business.

    Learn More
    Go to Insights
  • Security

    Red Hat Product Security Center

    Engage with our Red Hat Product Security team, access security updates, and ensure your environments are not exposed to any known security vulnerabilities.

    Product Security Center

    Security Updates

    • Security Advisories
    • Red Hat CVE Database
    • Security Labs

    Keep your systems secure with Red Hat's specialized responses to security vulnerabilities.

    View Responses

    Resources

    • Security Blog
    • Security Measurement
    • Severity Ratings
    • Backporting Policies
    • Product Signing (GPG) Keys
  • Community

    Customer Portal Community

    • Discussions
    • Private Groups
    Community Activity

    Customer Events

    • Red Hat Convergence
    • Red Hat Summit

    Stories

    • Red Hat Subscription Value
    • You Asked. We Acted.
    • Open Source Communities
Or troubleshoot an issue.

Select Your Language

  • English
  • 한국어
  • 日本語
  • 中文 (中国)

Infrastructure and Management

  • Red Hat Enterprise Linux
  • Red Hat Satellite
  • Red Hat Subscription Management
  • Red Hat Insights
  • Red Hat Ansible Automation Platform

Cloud Computing

  • Red Hat OpenShift
  • Red Hat OpenStack Platform
  • Red Hat OpenShift Container Platform
  • Red Hat OpenShift Data Science
  • Red Hat OpenShift Dedicated
  • Red Hat Advanced Cluster Security for Kubernetes
  • Red Hat Advanced Cluster Management for Kubernetes
  • Red Hat Quay
  • OpenShift Dev Spaces
  • Red Hat OpenShift Service on AWS

Storage

  • Red Hat Gluster Storage
  • Red Hat Hyperconverged Infrastructure
  • Red Hat Ceph Storage
  • Red Hat OpenShift Data Foundation

Runtimes

  • Red Hat Runtimes
  • Red Hat JBoss Enterprise Application Platform
  • Red Hat Data Grid
  • Red Hat JBoss Web Server
  • Red Hat Single Sign On
  • Red Hat support for Spring Boot
  • Red Hat build of Node.js
  • Red Hat build of Quarkus

Integration and Automation

  • Red Hat Application Foundations
  • Red Hat Fuse
  • Red Hat AMQ
  • Red Hat 3scale API Management
All Products

Table of contents

  1. Data Grid REST API
  2. Red Hat Data Grid
    1. Data Grid documentation
    2. Data Grid downloads
    3. Making open source more inclusive
    4. Providing feedback on Red Hat documentation
  3. 1. Data Grid REST Endpoint
    1. 1.1. REST Authentication
    2. 1.2. Supported Protocols
    3. 1.3. Data Formats and the REST API
      1. 1.3.1. Supported Formats
      2. 1.3.2. Accept Headers
      3. 1.3.3. Names with Special Characters
      4. 1.3.4. Key-Content-Type Headers
      5. 1.3.5. JSON/Protostream Conversion
    4. 1.4. Cross-Origin Resource Sharing (CORS) Requests
      1. 1.4.1. Allowing all CORS permissions for some origins
  4. 2. Interacting with the Data Grid REST API
    1. 2.1. Creating and Managing Caches
      1. 2.1.1. Creating Caches
        1. 2.1.1.1. Cache configuration
      2. 2.1.2. Modifying Caches
      3. 2.1.3. Verifying Caches
      4. 2.1.4. Creating Caches with Templates
      5. 2.1.5. Retrieving Cache Configuration
      6. 2.1.6. Converting Cache Configurations between XML, JSON and YAML
      7. 2.1.7. Comparing Cache Configurations
      8. 2.1.8. Retrieving All Cache Details
      9. 2.1.9. Retrieving Data Distribution of a Cache
      10. 2.1.10. Retrieving all mutable cache configuration attributes
      11. 2.1.11. Updating cache configuration attributes
      12. 2.1.12. Adding Entries
      13. 2.1.13. Replacing Entries
      14. 2.1.14. Retrieving Data By Keys
      15. 2.1.15. Checking if Entries Exist
      16. 2.1.16. Deleting Entries
      17. 2.1.17. Deleting Caches
      18. 2.1.18. Retrieving All Keys from Caches
      19. 2.1.19. Retrieving All Entries from Caches
      20. 2.1.20. Clearing Caches
      21. 2.1.21. Getting Cache Size
      22. 2.1.22. Getting Cache Statistics
      23. 2.1.23. Listing Caches
      24. 2.1.24. Listening to cache events
      25. 2.1.25. Enabling rebalancing
      26. 2.1.26. Disabling rebalancing
      27. 2.1.27. Getting Cache Availability
      28. 2.1.28. Setting Cache Availability
      29. 2.1.29. Indexing and Querying with the REST API
        1. 2.1.29.1. Rebuilding indexes
        2. 2.1.29.2. Updating index schema
        3. 2.1.29.3. Purging indexes
        4. 2.1.29.4. Get Indexes Metamodel
        5. 2.1.29.5. Retrieving Query and Index Statistics
        6. 2.1.29.6. Clearing Query Statistics
        7. 2.1.29.7. Retrieving Index Statistics (Deprecated)
        8. 2.1.29.8. Retrieving Query Statistics (Deprecated)
        9. 2.1.29.9. Clearing Query Statistics (Deprecated)
      30. 2.1.30. Cross-Site Operations with Caches
        1. 2.1.30.1. Getting status of all backup locations
        2. 2.1.30.2. Getting status of specific backup locations
        3. 2.1.30.3. Taking backup locations offline
        4. 2.1.30.4. Bringing backup locations online
        5. 2.1.30.5. Pushing state to backup locations
        6. 2.1.30.6. Canceling state transfer
        7. 2.1.30.7. Getting state transfer status
        8. 2.1.30.8. Clearing state transfer status
        9. 2.1.30.9. Modifying take offline conditions
        10. 2.1.30.10. Canceling state transfer from receiving sites
      31. 2.1.31. Rolling Upgrades
        1. 2.1.31.1. Connecting Source Clusters
        2. 2.1.31.2. Obtaining Source Cluster connection details
        3. 2.1.31.3. Checking if a Cache is connected
        4. 2.1.31.4. Synchronizing Data
        5. 2.1.31.5. Disconnecting Source Clusters
    2. 2.2. Creating and Managing Counters
      1. 2.2.1. Creating Counters
      2. 2.2.2. Deleting Counters
      3. 2.2.3. Retrieving Counter Configuration
      4. 2.2.4. Getting Counter Values
      5. 2.2.5. Resetting Counters
      6. 2.2.6. Incrementing Counters
      7. 2.2.7. Adding Deltas to Counters
      8. 2.2.8. Decrementing Counter Values
      9. 2.2.9. Performing compareAndSet Operations on Strong Counters
      10. 2.2.10. Performing compareAndSwap Operations on Strong Counters
      11. 2.2.11. Listing Counters
    3. 2.3. Working with Protobuf Schemas
      1. 2.3.1. Creating Protobuf Schemas
      2. 2.3.2. Reading Protobuf Schemas
      3. 2.3.3. Updating Protobuf Schemas
      4. 2.3.4. Deleting Protobuf Schemas
      5. 2.3.5. Listing Protobuf Schemas
      6. 2.3.6. Listing Protobuf Types
    4. 2.4. Working with Cache Managers
      1. 2.4.1. Getting Basic Cache Manager Information
      2. 2.4.2. Getting Cluster Health
      3. 2.4.3. Getting Cache Manager Health Status
      4. 2.4.4. Checking REST Endpoint Availability
      5. 2.4.5. Obtaining Global Configuration for Cache Managers
      6. 2.4.6. Obtaining Configuration for All Caches
      7. 2.4.7. Listing Available Cache Templates
      8. 2.4.8. Obtaining Cache Status and Information
      9. 2.4.9. Getting Cache Manager Statistics
      10. 2.4.10. Shutdown all container caches
      11. 2.4.11. Enabling rebalancing for all caches
      12. 2.4.12. Disabling rebalancing for all caches
      13. 2.4.13. Backing Up Data Grid Cache Managers
      14. 2.4.14. Listing Backups
      15. 2.4.15. Checking Backup Availability
      16. 2.4.16. Downloading Backup Archives
      17. 2.4.17. Deleting Backup Archives
      18. 2.4.18. Restoring Data Grid Resources from Backup Archives
        1. 2.4.18.1. Restoring from Backup Archives on Data Grid Server
        2. 2.4.18.2. Restoring from Local Backup Archives
      19. 2.4.19. Listing Restores
      20. 2.4.20. Checking Restore Progress
      21. 2.4.21. Deleting Restore Metadata
      22. 2.4.22. Listening to container configuration events
      23. 2.4.23. Listening to container events
      24. 2.4.24. Cross-Site Operations with Cache Managers
        1. 2.4.24.1. Getting status of backup locations
        2. 2.4.24.2. Taking backup locations offline
        3. 2.4.24.3. Bringing backup locations online
        4. 2.4.24.4. Retrieving the state transfer mode
        5. 2.4.24.5. Setting the state transfer mode
        6. 2.4.24.6. Starting state transfer
        7. 2.4.24.7. Canceling state transfer
    5. 2.5. Working with Data Grid Servers
      1. 2.5.1. Retrieving Basic Server Information
      2. 2.5.2. Getting Cache Managers
      3. 2.5.3. Adding Caches to Ignore Lists
      4. 2.5.4. Removing Caches from Ignore Lists
      5. 2.5.5. Confirming Ignored Caches
      6. 2.5.6. Obtaining Server Configuration
      7. 2.5.7. Getting Environment Variables
      8. 2.5.8. Getting JVM Memory Details
      9. 2.5.9. Getting JVM Heap Dumps
      10. 2.5.10. Getting JVM Thread Dumps
      11. 2.5.11. Getting Diagnostic Reports for Data Grid Servers
      12. 2.5.12. Stopping Data Grid Servers
    6. 2.6. Working with Data Grid Clusters
      1. 2.6.1. Stopping Data Grid Clusters
      2. 2.6.2. Stopping Specific Data Grid Servers in Clusters
      3. 2.6.3. Backing Up Data Grid Clusters
      4. 2.6.4. Listing Backups
      5. 2.6.5. Checking Backup Availability
      6. 2.6.6. Downloading Backup Archives
      7. 2.6.7. Deleting Backup Archives
      8. 2.6.8. Restoring Data Grid Cluster Resources
        1. 2.6.8.1. Restoring from Backup Archives on Data Grid Server
        2. 2.6.8.2. Restoring from Local Backup Archives
      9. 2.6.9. Listing Restores
      10. 2.6.10. Checking Restore Progress
      11. 2.6.11. Deleting Restore Metadata
      12. 2.6.12. Checking Cluster Distribution
    7. 2.7. Data Grid Server logging configuration
      1. 2.7.1. Listing the logging appenders
      2. 2.7.2. Listing the loggers
      3. 2.7.3. Creating/modifying a logger
      4. 2.7.4. Removing a logger
    8. 2.8. Using Server Tasks
      1. 2.8.1. Retrieving Server Tasks Information
      2. 2.8.2. Executing Tasks
      3. 2.8.3. Uploading Script Tasks
      4. 2.8.4. Downloading Script Tasks
    9. 2.9. Working with Data Grid Security
      1. 2.9.1. Retrieving the ACL of a user
      2. 2.9.2. Flushing the ACL cache
      3. 2.9.3. Retrieving the available roles
      4. 2.9.4. Retrieving the roles for a principal
      5. 2.9.5. Granting roles to a principal
      6. 2.9.6. Denying roles to a principal
  5. Legal Notice

Data Grid documentation

Documentation for Data Grid is available on the Red Hat customer portal.

  • Data Grid 8.4 Documentation
  • Data Grid 8.4 Component Details
  • Supported Configurations for Data Grid 8.4
  • Data Grid 8 Feature Support
  • Data Grid Deprecated Features and Functionality
  1. Previous
  2. Next
Red Hat

Quick Links

  • Downloads
  • Subscriptions
  • Support Cases
  • Customer Service
  • Product Documentation

Help

  • Contact Us
  • Customer Portal FAQ
  • Log-in Assistance

Site Info

  • Trust Red Hat
  • Browser Support Policy
  • Accessibility
  • Awards and Recognition
  • Colophon

Related Sites

  • redhat.com
  • developers.redhat.com
  • connect.redhat.com
  • cloud.redhat.com

About

  • Red Hat Subscription Value
  • About Red Hat
  • Red Hat Jobs
Copyright © 2023 Red Hat, Inc.
  • Privacy Statement
  • Terms of Use
  • All Policies and Guidelines
Red Hat Summit Red Hat Summit
Twitter