RDS Snap Backup

Select

SaaS

Customer Managed

This operation is used to submit backup operations for RDS Snap.

application/json

Request Body

taskInfo object
associations object[]
clientName string required
Name of Cloud account.
instanceName string required
Name of the RDS instance.
displayName string
Display name of Cloud account
_type_ string required
Possible values: [SUBCLIENT_ENTITY]
appName string required
Possible values: [Cloud Apps]
subclientName string required
Name of subclient
task object
taskType string
Possible values: [IMMEDIATE, SCHEDULE]
subTasks object[]
subTask object
subTaskType string
Default value: BACKUP
operationType string
Default value: BACKUP
options object
backupOpts object
backupLevel string
Default value: FULL
commonOpts object
notifyUserOnJobCompletion boolean
Default value: true

Responses

application/json

Schema
Example (from schema)
Response for Instance level backup

Schema

taskId integer
jobIds string[]
Job id for the backup job.

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 402,
  "jobIds": [
    "1354"
  ]
}

Bad Request

application/json

Schema
Example 1

Schema

string

Request body is empty or format is invalid

Internal Server Error

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Failed to start backups as no eligible subclients were found.  ",
  "errorCode": 587207178
}

POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Body

Default
Backup

{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "SUBCLIENT_ENTITY",
        "appName": "Cloud Apps",
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "BACKUP",
          "operationType": "BACKUP"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL"
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

RDS Snap Backup​

Authorization

Request

RDS Snap Backup