Backup



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/backups

Summary


Resources Methods
https://localhost:8443/api/rest/backups

GET  Acquire the list of backups stored locally on the server.

DELETE  Deletes all backup, restore, and restore status files.

POST  Upload a backup.

https://localhost:8443/api/rest/backups/{backup-name}

GET  Download the backup.

DELETE  Remove the backup.

https://localhost:8443/api/rest/backups/{backup-name}/restore

POST  Restore the backup.

https://localhost:8443/api/rest/backups/backup-now

POST  Create a full backup.

https://localhost:8443/api/rest/backups/backup-config-only

POST  Create a config only backup.

https://localhost:8443/api/rest/backups/url

POST  Upload a backup file using a url.

https://localhost:8443/api/rest/backups/restore-status

GET  Acquires the status of the last attempted restore.

DELETE  Deletes the restore status.

Resources


https://localhost:8443/api/rest/backups


Methods

GET


Acquire the list of backups stored locally on the server.
[tags:
DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-local-backup-list+xml
application/vnd.plcm.plcm-local-backup-list+json
The list of backups is successfully retrieved.
304
List of local backups information has not been changed since
the last
search.

Note: The API client must provide the
"plcm-local-backup-list"
representation's
ETag value in the
"If-None-Match" HTTP header to ensure conditional
retrieval.
This
will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value
from a previous,
identical
search in the "If-None-Match" header,
then the HTTP response will
contain the
search results in the
message body.
The "plcm-local-backup-list" ETag can be accessed
from the initial
search result's HTTP
response header. This also
assumes no other client made changes to
remote backup config on the
server.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.

DELETE


Deletes all backup, restore, and restore status files.

Response

Status Representation Description
204 Files successfully deleted
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator

POST


Upload a backup. [tags: DMA]

Request

Response

Status Representation Description
201 A backup file will successfully be uploaded.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
402 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file was not free of malware infection and has been deleted.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Backup file not found for upload.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The backup file is not compatible with the current version of your system.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file was determined not to be compatible with a DMA system.
413 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file is too big.
415 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unknown upload backup file format.
429 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Too many requests. Maximum number of concurrent requests in progress. Try back later.

https://localhost:8443/api/rest/backups/{backup-name}


Template Parameters

Name Type Description
backup-name xs:string The name of the backup.

Methods

GET


Download the backup.
[tags: DMA]

Request

Response

Status Representation Description
200 application/octet-stream
The backup was successfully downloaded.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
429 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Too many requests. Maximum number of concurrent requests in progress. Try back later.

DELETE


Remove the backup.
[tags: DMA]

Request

Response

Status Representation Description
204 The backup was successfully deleted.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.

https://localhost:8443/api/rest/backups/{backup-name}/restore


Template Parameters

Name Type Description
backup-name xs:string The name of the backup.

Methods

POST


Restore the backup.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-restore-backup+xml
application/vnd.plcm.plcm-restore-backup+json

Response

Status Representation Description
202 The request has been accepted to restore a backup.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The client sent data in the body that has an element that doesn't match the corresponding element of the URL.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The backup file does not exist.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
One restore type must be true.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There was a problem restoring the backup file.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Restore/Backup already in progress.

https://localhost:8443/api/rest/backups/backup-now


Methods

POST


Create a full backup. [tags: DMA]

Request

Response

Status Representation Description
202 A backup will be created.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There was a problem while creating backup.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Restore/Backup already in progress.

https://localhost:8443/api/rest/backups/backup-config-only


Methods

POST


Create a config only backup. [tags: DMA]

Request

Response

Status Representation Description
202 A config only backup will be created.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There was a problem while creating config only backup.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Restore/Backup already in progress.

https://localhost:8443/api/rest/backups/url


Methods

POST


Upload a backup file using a url. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-backup-upload-url+xml
application/vnd.plcm.plcm-backup-upload-url+json

Response

Status Representation Description
201 A backup file will successfully be uploaded using a url.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
402 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file was not free of malware infection and has been deleted.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Backup file not found for upload.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The backup file is not compatible with the current version of your system.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file was determined not to be compatible with a DMA system.
413 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file is too big.
415 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unknown upload backup file format.
429 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Too many requests. Maximum number of concurrent requests in progress. Try back later.

https://localhost:8443/api/rest/backups/restore-status


Methods

GET


Acquires the status of the last attempted restore. [tags: DMA]

Request

Response

Status Representation Description
202 The status of the last attempted restore.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.

DELETE


Deletes the restore status. [tags: DMA]

Request

Response

Status Representation Description
202 The status of the last attempted restore.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.