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
  3. NetBackup™ for MySQL Administrator's Guide
  5. API for MySQL instances and databases
  7. Using APIs to manage, protect or restore MySQL
NetBackup™ for MySQL Administrator's Guide

Using APIs to manage, protect or restore MySQL

This topic lists the APIs to manage, protect or restore the MySQL instances and databases. Only the important variables and options are mentioned in this topic.

Following sections are part of this topic:

  • See Add a MySQL instance.

  • See MySQL Discovery API.

  • See Create a MySQL Protection Plan.

  • See MySQL Recovery point Service API .

  • See Restore the MySQL instance and database at the original location .

  • See Restore the MySQL instance and database to an alternate location .

For detailed information on the APIs, use these references:

  • All the NetBackup APIs are listed at the following location:

    Services and Operations Readiness Tools (SORT) > Knowledge Base > Documents

Add a MySQL instance

Table: Add a MySQL instance

API

Important variables and options

POST
/netbackup/asset-service/queries
GET
/netbackup/asset-service/queries/{aqcId}
GET
/netbackup/asset-service/workloads 
/mysql/assets

  • clientName is the name of the MySQL instance.

  • sqlHostName is hostname of a NetBackup client.

  • credentialName are credentials associated with MySQL instance.

    Note:

    The credential must exist with credentialName mentioned.

  • port is port number of MySQL instance.

MySQL Discovery API

Table: Discover the MySQL asset for given client

API

Important variables and options

POST
/netbackup/admin/discovery
/workloads/mysql/start

POST 
/netbackup/admin/discovery/workloads
/mysql/stop

GET
/netbackup/admin/discovery/workloads
/mysql/status

POST 
/netbackup/admin/discovery/workloads
/mysql/allclientsdiscovery

  • serverName is used to identify instance or database

  • discoveryHost is hostname where discovery needs to be triggered

  • allclientsdiscovery triggers discovery for all the clients host associated with the master.

Create a MySQL Protection Plan

Table: Create a MySQL Protection Plan

API

Important variables and options

POST 
/netbackup/servicecatalog/slos

POST
/netbackup/servicecatalog/slos/{sloId}
/subscriptions

POST
/netbackup/servicecatalog/slos/{sloId}
/backup-now

  • policyType is DataStore.

  • Add scheduleName can have values like FULL_AUTO or INCR_AUTO for adding MySQL instance.

  • keyword can have the following values to back up an instance or database using different backup options:

    • mysqldump

    • Snapshot

    • xtrabackup

  • sloId is the identifier to protection plan

  • selectionId is the AssetId which needs to be subscribed with given sloId

After you create a protection plan, other processes like creating the schedule for the policy or triggering the policy backup remain the same.

MySQL Recovery point Service API

Table: MySQL asset backup instances available for recovery

API

Important variables and options

GET
/netbackup/recovery-point-service
/workloads/mysql/recovery-points 

GET
/netbackup/recovery-point-service
/workloads/mysql/recovery-points
/{backupId}


GET
/netbackup/wui/workloads/mysql
/recovery-point-calendar-summary

  • backupId is identifier that was used at the time of backup.

  • assetId is identifier that was used to identify instance or database.

  • client hostname is name of backup client.

Restore the MySQL instance and database at the original location

Table: Restore the MySQL instance and database at the original location

API

Important variables and options

POST
/netbackup/recovery/workloads/mysql/
scenarios/instance-complete-recovery  
/recover
POST 
/netbackup/recovery/workloads/mysql   
/scenarios/database-complete-recovery
/recover

  • backupId is identifier that was used at the time of backup.

  • assetId is identifier that was used to identify instance or database.

  • Client is server that is to be used as the MySQL recovery host to perform this recovery. Set the following value:

    renameAllFilesToSameLocation
Restore the MySQL instance and database to an alternate location

Table: Restore the MySQL instance and database to an alternate location

API

Important variables and options

POST
/netbackup/recovery/workloads/mysql/
scenarios/instance-complete-recovery
/recover
POST 
/netbackup/recovery/workloads/mysql
/scenarios/database-complete-recovery
/recover

  • backupId is identifier that was used at the time of backup.

  • assetId is identifier that was used to identify instance or database.

  • Client is server that is to be used as the MySQL recovery host to perform this recovery. Set the following value:

    renameEachFileToDifferentLocation

Feedback

Was this page helpful?
Previous

API for MySQL instances and databases

Next

Overview

Feedback

Was this page helpful?