Skip to main content

MySQL Backup Operations

This operation is used to run MySQL backups

Request Body
  • taskInfo object
  • task object
  • taskType required

    Possible values: [IMMEDIATE, SCHEDULE]

  • associations object[] required
  • instanceName string required

    MySQL Instance name

  • appName string required

    Default value: MySQL

    Application Name

  • clientName string required

    Database Server name

  • subclientName string required

    Database group name

  • subTasks object[]
  • subTask object required
  • subTaskType string required

    Default value: BACKUP

  • operationType string required

    Default value: BACKUP

  • options object
  • backupOpts object

    Backup Options

  • backupLevel required

    Possible values: [FULL, INCREMENTAL, SYNTHETIC_FULL]

  • incLevel string required
  • doNotTruncateLog boolean

    Purge Binary logs

  • truncateLogsOnSource boolean

    Proxy Backup option to Purge binary logs on Source MySQL Instance

  • incrementalDataWithLogs boolean

    Incremental Backup with Logs (applicable for MySQL Block Level backup and Full Instance Xtrabackup)

  • commonOpts object
  • notifyUserOnJobCompletion boolean
Responses

OK

Response Headers

    Schema
    • taskId integer
    • jobIds string[]

      JobId of install job triggered

    POST /createtask    

    Authorization

    type: apiKeyname: Authtokenin: header

    Request

    Click Edit to configure Base URL
    https://CommandCenterHostName/commandcenter/api
    Security Scheme
    token
    Body

    {
    "taskInfo": {
    "task": {},
    "associations": [
    {
    "instanceName": "string",
    "appName": "MySQL",
    "clientName": "string",
    "subclientName": "string"
    }
    ],
    "subTasks": [
    {
    "subTask": {
    "subTaskType": "BACKUP",
    "operationType": "BACKUP"
    },
    "options": {
    "backupOpts": {
    "incLevel": "string",
    "doNotTruncateLog": true,
    "truncateLogsOnSource": true,
    "incrementalDataWithLogs": true
    },
    "commonOpts": {
    "notifyUserOnJobCompletion": true
    }
    }
    }
    ]
    }
    }
    curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authtoken: <API_KEY_VALUE>' \
    --data-raw '{
    "taskInfo": {
    "task": {},
    "associations": [
    {
    "instanceName": "string",
    "appName": "MySQL",
    "clientName": "string",
    "subclientName": "string"
    }
    ],
    "subTasks": [
    {
    "subTask": {
    "subTaskType": "BACKUP",
    "operationType": "BACKUP"
    },
    "options": {
    "backupOpts": {
    "incLevel": "string",
    "doNotTruncateLog": true,
    "truncateLogsOnSource": true,
    "incrementalDataWithLogs": true
    },
    "commonOpts": {
    "notifyUserOnJobCompletion": true
    }
    }
    }
    ]
    }
    }'