Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 4. Performing cross-site operations with the REST API

Data Grid Server provides a REST endpoint that exposes methods for performing cross-site operations.

4.1. Getting status of all backup locations
Copy link

Retrieve the status of all backup locations with GET requests. 

GET /rest/v2/caches/{cacheName}/x-site/backups/
Copy to Clipboard Toggle word wrap

Data Grid responds with the status of each backup location in JSON format, as in the following example: 

{
  "NYC": {
    "status": "online"
  },
  "LON": {
    "status": "mixed",
    "online": [
      "NodeA"
    ],
    "offline": [
      "NodeB"
    ]
  }
}
Copy to Clipboard Toggle word wrap
Expand
Table 4.1. Returned Status
ValueDescription

online

All nodes in the local cluster have the backup location with online status.

offline

All nodes in the local cluster have the backup location with offline status.

mixed

Some nodes in the local cluster have the backup location with online status while others have the backup location with offline status. The response indicates status for each node.

4.2. Getting status of specific backup locations
Copy link

Retrieve the status of a backup location with GET requests. 

GET /rest/v2/caches/{cacheName}/x-site/backups/{siteName}
Copy to Clipboard Toggle word wrap

Data Grid responds with the status of each node in JSON format, as in the following example: 

{
  "NodeA":"offline",
  "NodeB":"online"
}
Copy to Clipboard Toggle word wrap
Expand
Table 4.2. Returned Status
ValueDescription

online

The node has {siteName} with online status

offline

The node has {siteName} with offline status

failed

Not possible to retrieve status. The remote cache could be shutting down or a network error occurred during the request.

4.3. Taking backup locations offline
Copy link

Take backup locations offline with POST requests and the ?action=take-offline parameter. 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=take-offline
Copy to Clipboard Toggle word wrap

4.4. Bringing backup locations online
Copy link

Bring backup locations online with the ?action=bring-online parameter. 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=bring-online
Copy to Clipboard Toggle word wrap

4.5. Pushing state to backup locations
Copy link

Push cache state to a backup location with the ?action=start-push-state parameter. 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=start-push-state
Copy to Clipboard Toggle word wrap

4.6. Canceling state transfer
Copy link

Cancel state transfer operations with the ?action=cancel-push-state parameter. 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-push-state
Copy to Clipboard Toggle word wrap

4.7. Getting state transfer status
Copy link

Retrieve status of state transfer operations with the ?action=push-state-status parameter. 

GET /rest/v2/caches/{cacheName}/x-site/backups?action=push-state-status
Copy to Clipboard Toggle word wrap

Data Grid responds with the status of state transfer for each backup location in JSON format, as in the following example: 

{
   "NYC":"CANCELED",
   "LON":"OK"
}
Copy to Clipboard Toggle word wrap
Expand
Table 4.3. Returned status
ValueDescription

SENDING

The state transfer to the backup location is in progress.

OK

The state transfer completed successfully.

ERROR

An error occurred with state transfer. Check the log files.

CANCELLING

The state transfer cancellation is in progress.

4.8. Clearing state transfer status
Copy link

Clear the state transfer status in the sending cluster with the ?action=clear-push-state-status parameter. It is recommended to clear it before starting the push for a new state transfer. 

POST /rest/v2/caches/{cacheName}/x-site/local?action=clear-push-state-status
Copy to Clipboard Toggle word wrap

4.9. Modifying take offline conditions
Copy link

The backup location go offline when certain conditions are met. Modify the take offline parameters to control when backup locations automatically go offline.

Procedure

  1. Check configured take offline parameters with GET requests and the take-offline-config parameter. 

    GET /rest/v2/caches/{cacheName}/x-site/backups/{siteName}/take-offline-config
    Copy to Clipboard Toggle word wrap

    The Data Grid response includes after_failures and min_wait fields as follows: 

    {
  "after_failures": 2,
  "min_wait": 1000
}
    Copy to Clipboard Toggle word wrap

  2. Modify the take offline parameters in the body of PUT requests. 

    PUT /rest/v2/caches/{cacheName}/x-site/backups/{siteName}/take-offline-config
    Copy to Clipboard Toggle word wrap

If the operation successfully completes, the service returns 204 (No Content).

If the connection between two backup locations breaks, you can cancel state transfer on the backup location that is receiving the push.

Cancel state transfer from another location and keep the current state of the local cache with the ?action=cancel-receive-state parameter. 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-receive-state
Copy to Clipboard Toggle word wrap

4.11. Retrieving the state transfer mode
Copy link

Check the state transfer mode with GET requests. 

GET /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode
Copy to Clipboard Toggle word wrap

4.12. Setting the state transfer mode
Copy link

Configure the state transfer mode with the ?action=set parameter. 

POST /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode?action=set&mode={mode}
Copy to Clipboard Toggle word wrap

4.13. Getting status of backup locations
Copy link

Retrieve the status of all backup locations with GET requests. 

GET /rest/v2/container/x-site/backups/
Copy to Clipboard Toggle word wrap

Data Grid responds with status in JSON format, as in the following example: 

{
   "SFO-3":{
      "status":"online"
   },
   "NYC-2":{
      "status":"mixed",
      "online":[
         "CACHE_1"
      ],
      "offline":[
         "CACHE_2"
      ],
      "mixed": [
         "CACHE_3"
      ]
   }
}
Copy to Clipboard Toggle word wrap
Expand
Table 4.4. Returned Status
ValueDescription

online

All caches in the local cluster have the backup location with online status.

offline

All caches in the local cluster have the backup location with offline status.

mixed

Some caches in the local cluster have the backup location with online status while others have the backup location with offline status. The response indicates status for each cache. 

GET /rest/v2/container/x-site/backups/{site}
Copy to Clipboard Toggle word wrap

Returns the status for a single backup location.

4.14. Taking backup locations offline
Copy link

Take backup locations offline with the ?action=take-offline parameter. 

POST /rest/v2/container/x-site/backups/{siteName}?action=take-offline
Copy to Clipboard Toggle word wrap

4.15. Bringing backup locations online
Copy link

Bring backup locations online with the ?action=bring-online parameter. 

POST /rest/v2/container/x-site/backups/{siteName}?action=bring-online
Copy to Clipboard Toggle word wrap

4.16. Starting state transfer
Copy link

Push state of all caches to remote sites with the ?action=start-push-state parameter. 

POST /rest/v2/container/x-site/backups/{siteName}?action=start-push-state
Copy to Clipboard Toggle word wrap

4.17. Canceling state transfer
Copy link

Cancel ongoing state transfer operations with the ?action=cancel-push-state parameter. 

POST /rest/v2/container/x-site/backups/{siteName}?action=cancel-push-state
Copy to Clipboard Toggle word wrap
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top