/api/space/config-file-management/exec-backup

The following operation is supported on this resource:

  • POST - Back up configuration files for the devices
POST /exec-backupVersion 1

This API is used to back up configuration files in the database for a given list of devices.

Sample Usage

POST /exec-backup


  • Sample Input XML:
    <exec-backup>
      <devices>
          <device href= "/api/space/device-management/devices/6750219"/>
          <device href= "/api/space/device-management/devices/6750220"/>
      </devices>
      <scpProperty>
          <ipAddress>192.168.27.250</ipAddress>
          <port>22</port>
          <fingerprint>03:f9:30:cd:80:27:67:b1:46:26:a5:3c:2c:1c:04:1c</fingerprint>
          <directory>/var/tmp/</directory>
          <credentialType>CREDENTIAL_BASED</credentialType>
          <user-name>root</user-name>
          <password>*********</password>
          <passPhrase>test_phrase</passPhrase>
          <privateKey>MIIEogIBAAKCAQEAxzybh9VkWiJ0gN0O4o</privateKey>
      </scpProperty>
    </exec-backup>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/1245205">
       <id>1245205</id>
    </task>

  • Sample Input JSON:
     {
        "exec-backup":{
            "devices":{
                  "device":[
                     {
                        "@href": "/api/space/device-management/devices/6750219"
                     },
                     {
                        "@href": "/api/space/device-management/devices/6750220"
                     }
                   ]
        },
            "scpProperty":{
                  "ipAddress":"192.168.27.250",
                  "port":"22",
                  "fingerprint":"03:f9:30:cd:80:27:67:b1:46:26:a5:3c:2c:1c:04:1c",
                  "directory":"/var/tmp/",
                  "credentialType":"CREDENTIAL_BASED",
                  "user-name":"root",
                  "password":"*********",
                  "passPhrase":"test_phrase",
                  "privateKey":"MIIEogIBAAKCAQEAxzybh9VkWiJ0gN0O4o"
            }
        }
      }

  • Sample Output JSON:
     {
        "task": {
            "@href": "/api/space/job-management/jobs/1245205",
            "id": 1245205
        }
     }

  • Access Control

    The following capabilities are required to access this API: BackupConfigFilesCap