V11 SP8
Loading...

REST API - POST Backup Set

This operation creates a backup set.

Request

Syntax

Send the request using either XML or JSON:

  • XML

    POST <webservice>/Backupset HTTP/1.1
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>
    Content-type: application/xml

    <create_backup_set_template.xml>

  • JSON

    POST <webservice>/Backupset HTTP/1.1
    Host: <host name>
    Accept: application/json
    Authtoken: <authentication token>
    Content-type: application/json

    <create_backup_set_template.json>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.
Content-type The media type contained in the request body.

Request Body

Download the XML or JSON file required for this request: create_backup_set_template.xml or create_backup_set_template.json. The following table displays the parameters for the request body.

Parameter Description Element
appName The name of the application.

Valid values are:

  • Exchange Database
  • File System
  • MySQL
  • NAS
  • Notes Database
  • Oracle
  • Oracle RAC
  • PostgreSQL
  • SAP for MAX DB
  • SAP for Oracle
  • SQL Server
  • Sybase Database
  • Virtual Server
entity
backupsetName The name of the backup set. entity
clientName The name of the client. entity
instanceName The name of the instance, for example: DefaultInstanceName. entity
onDemandBackupset The option to create an on-demand backup set.

Valid values are True/False.

commonBackupSet

Response

Response Parameters

Parameter Description Element
errorCode The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.
response
errorString The description of the error code. Not all error codes have an error string. response

Examples

Sample Request

POST <webservice>/Backupset HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<App_CreateBackupSetRequest>
  <association>
    <entity>
      <appName>File System</appName>
      <backupsetName>FS_Backup_01</backupsetName>
      <clientName>client001</clientName>
      <instanceName>DefaultInstanceName</instanceName>
    </entity>
  </association>
</App_CreateBackupSetRequest>

Sample Response

This is the response when the backup set is created.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResponse>
<response errorCode="0">
<entity _type_="ROOT_ENTITY" applicationId="33" backupsetId="931" clientId="2" clientSidePackage="true" consumeLicense="true" type="GALAXY"/>
</response>
</App_GenericResponse>

This is the response when the backup set is not created because an invalid client name was provided in the request.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResponse>
<response errorCode="1" errorString="DB error: please refer to logs for more details.">
<entity _type_="ROOT_ENTITY" applicationId="33" backupsetId="0" clientId="2" clientSidePackage="true" consumeLicense="true" type="GALAXY"/>
</response>
</App_GenericResponse>