Ransomware attackers specifically target and attempt to destroy backup systems to increase the probability of payment. Hardening your system is critical. Please ensure you have reviewed your platform security using the Security Hardening Checklist
Cohesity

COHESITY Documentation

Explore our documentation to get started, discover products & new features, access troubleshooting guides, register sources, platforms support.

Products
Data Security Alliance
Visit Cohesity.com
Demos
Support
Blogs
Developers
Partner Portals
Cohesity Community
© 2026 Cohesity, Inc. All Rights Reserved.
Terms of Use|
Privacy Policy|
Legal|
  1. Home
  2. NetBackup™ Flex Scale Administrator's Guide
  3. Resiliency in NetBackup Flex Scale
  4. NetBackup primary service catalog protection using checkpoints
  5. Performing a recovery of the catalog file system using REST APIs
NetBackup™ Flex Scale Administrator's Guide

Performing a recovery of the catalog file system using REST APIs

You can use REST APIs for the recovery of primary service catalog file system from the checkpoints. The REST API calls should be made in the following order:

  1. Get the list of checkpoints for the primary service catalog file system. This API returns a list of all the available checkpoints for the primary catalog file system. The checkpoints can be used to recover the data.

    GET /api/appliance/v1.0/netbackup/checkpoints
    URI : /api/appliance/v1.0/netbackup/checkpoints
    Type : GET
    Response Body:
          {
      	"links": {
        	  "self": {
          	    "href": "/api/appliance/v1.0/netbackup/checkpoints"
              }
            },
      	"data": [
        	  {
          	    "type": "netbackup",
          	    "id": "1",
                "links": {
                  "self": {
                    "href": "/api/appliance/v1.0/netbackup/checkpoints/
    																	checkpoint1"
                  }
                }
              }
            ]
          }

    The checkpoint name which is returned by this API should be passed as input to the API which is called to restore the catalog.

  2. Validate a checkpoint. This API validates the checkpoint by creating a new checkpoint from the selected checkpoint and runs the NetBackup database validation on the newly created checkpoint. After validation completes the new checkpoint can be used for restore.

    POST /api/appliance/v1.0/netbackup/checkpoints/restore-catalog/
    {checkpointName}
    URI: /api/appliance/v1.0/netbackup/checkpoints/restore-catalog/{
    checkpointName}
    Type : POST
    Input Parameter for Request : Checkpoint name
    Response: 
    	{
      	    "taskId": "string",
      	    "message": "string"
    	}

    This is an asynchronous API and it returns a task ID when API execution is successful. You can find the execution status and details by providing this taskID as input in the GET {taskId} API. The task is also visible in the Recent activity icon in the top navigation bar in the GUI.

  3. Restore the data to the primary service catalog file system. This API restores the data (from the checkpoint that is created in the previous step) to the primary service catalog file system.

    POST /api/appliance/v1.0/netbackup/checkpoints/sync-catalog
    URI : /api/appliance/v1.0/netbackup/checkpoints/sync-catalog
    Type : POST
    Input Parameters : None
    Response :
    	{
      	    "taskId": "string",
      	    "message": "string"
    	}

    This is an asynchronous API and it returns a task ID when API execution is successful. You can find the execution status and details by providing this taskID as input in the GET {taskId} API. The task is also visible in the Recent activity icon in the top navigation bar in the GUI.

Feedback

Was this page helpful?
Previous

Performing a recovery of the catalog file system using GUI

Next

EMS server configuration

Feedback

Was this page helpful?