RemoteBackup

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/remote-backup

Summary

Resources	Methods
https://localhost:8443/api/rest/remote-backup
https://localhost:8443/api/rest/remote-backup/backup-config	GET Get the remote backup config objects. PUT Updating remote backup config.
https://localhost:8443/api/rest/remote-backup/last-backup	GET Get the last remote backup information.
https://localhost:8443/api/rest/remote-backup/local-backups	GET Get the list of backups stored locally on the server.
https://localhost:8443/api/rest/remote-backup/test-settings	POST The remote server will be contacted using the specified settings.
https://localhost:8443/api/rest/remote-backup/backup-now	POST Backup will be created and transferred to the remote server.
https://localhost:8443/api/rest/remote-backup/transfer-backup	POST The provided file will be transferred to remote server.

Resources

https://localhost:8443/api/rest/remote-backup

https://localhost:8443/api/rest/remote-backup/backup-config

Methods

GET

Get the remote backup config objects.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-remote-backup-config+xml application/vnd.plcm.plcm-remote-backup-config+json	Remote backup config successfully retrieved.
304		Remote backup config has not been changed since the last search. Note: The API client must provide the "plcm-remote-backup-config" 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-remote-backup-config" 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.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed

PUT

Updating remote backup config.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-remote-backup-config+xml

application/vnd.plcm.plcm-remote-backup-config+json

Response

Status	Representation	Description
204		Remote backup config successfully updated. Note: The response will only contain both an ETag value and link to the updated remote backup config resource.
400	text/plain	Bad request.
400	text/plain	Remote IP size must be between 0 and 255.
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	Next backup date should be current or future date.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Please provide seconds after midnight
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Next backup date and time are required
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Backup frequency should be in range of 1 to 999
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Please provide a valid backup type
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid backup type
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Please provide a valid transfer protocol
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid transfer protocol
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid hostname or IP address.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Hostname or IP address cannot be blank
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Username contains invalid character.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Username size must be between 0 and 255.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Password size must be between 0 and 255.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote directory contains invalid character.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote Directory size must be between 0 and 1000.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote port must be between 1 and 65535
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. The API client must retrieve the latest resource version, apply the resource modifications, then update to the server.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-remote-backup-config.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request contained ETags in both the header (header-ETag) and the body (body-ETag) and they do not match.

https://localhost:8443/api/rest/remote-backup/last-backup

Methods

GET

Get the last remote backup information. It will provide last backup date and size in bytes.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-last-remote-backup+xml application/vnd.plcm.plcm-last-remote-backup+json	Last remote backup information successfully retrieved.
304		Last successful remote backup information has not been changed since the last search. Note: The API client must provide the "plcm-last-remote-backup" 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-last-remote-backup" 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.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed

https://localhost:8443/api/rest/remote-backup/local-backups

Methods

GET

Get 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	Last successful remote backup information 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.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed

https://localhost:8443/api/rest/remote-backup/test-settings

Methods

POST

The remote server will be contacted using the specified settings.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-remote-backup-test-request+xml

application/vnd.plcm.plcm-remote-backup-test-request+json

Response

Status	Representation	Description
200		The remote server was successfully contacted using the specified settings.
400	text/plain	Bad request.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Authentication failed
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Transfer protocol may not be null.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid transfer protocol
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote IP size must be between 0 and 255.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid hostname or IP address.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Hostname or IP address cannot be blank
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Username contains invalid character.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote directory contains invalid character.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote Directory size must be between 0 and 1000.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote port must be between 1 and 65535
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Username size must be between 0 and 255.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Password size must be between 0 and 255.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Username or password is incorrect, please check the settings
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not establish connection with remote server due to socket error
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server refused the connection
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server name or service unknown
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote directory does not exist or does not have write permission
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server is unknown or not reachable
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server replied with error code forbidden
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the backup archive because remote server does not allow PUT method
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote service is not available
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, connection timed out
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the backup archive because remote server does not have sufficient storage space
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, destination network is not reachable
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, no route to host available
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server replied with invalid response, please check the settings
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server encountered an error while parsing the request
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server closed the connection
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the archive due to TLS handshake failure

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

Methods

POST

Backup will be created and transferred to the remote server.
[tags: DMA]

Response

Status	Representation	Description
202		The request has been accepted to create backup and transfer to the remote server
400	text/plain	Bad request.
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	Username or password is incorrect, please check the settings
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not establish connection with remote server due to socket error
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server refused the connection
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server name or service unknown
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote directory does not exist or does not have write permission
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server is unknown or not reachable
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server replied with error code forbidden
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the backup archive because remote server does not allow PUT method
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote service is not available
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, connection timed out
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the backup archive because remote server does not have sufficient storage space
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, destination network is not reachable
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, no route to host available
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server replied with invalid response, please check the settings
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server encountered an error while parsing the request
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server closed the connection
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the archive due to TLS handshake failure
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Automatic backups of this cluster to a remote server is disabled.

https://localhost:8443/api/rest/remote-backup/transfer-backup

Methods

POST

The provided file will be transferred to remote server.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-remote-backup-transfer-request+xml

application/vnd.plcm.plcm-remote-backup-transfer-request+json

Response

Status	Representation	Description
202		The request has been accepted to transfer backup to remote server.
400	text/plain	Bad request.
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	Username or password is incorrect, please check the settings
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not establish connection with remote server due to socket error
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server refused the connection
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server name or service unknown
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote directory does not exist or does not have write permission
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server is unknown or not reachable
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server replied with error code forbidden
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the backup archive because remote server does not allow PUT method
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote service is not available
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, connection timed out
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the backup archive because remote server does not have sufficient storage space
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, destination network is not reachable
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not connect to remote host, no route to host available
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server replied with invalid response, please check the settings
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server encountered an error while parsing the request
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote server closed the connection
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Could not transfer the archive due to TLS handshake failure
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Automatic backups of this cluster to a remote server is disabled.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Please provide a valid backup file name.