Page History

Restore Snapshot

• Purpose: Enables user to initiate the restoration of a snapshot

• Request: PUT https://host:port/bridge/restore

  Code Block
  { "host" : "", "port" : "", "storeId" : "", "spaceId" : "", "snapshotId" : "", "userEmail" : "" }

• Response Code: 200 (on success)

• Response Body: JSON:

  Code Block
  { "restoreId" : "" "status" : "" }

   Possible value for status (see Get Restore Details)

Restore Complete

• Purpose: Enables DPN provider to notify bridge app that a snapshot has been restored to bridge storage.
• Request: POST https://host:port/bridge/restore/(restoreId)/complete
  • restoreId - Identifier of the restoration
• Response Code: 200 (on success)

• Response Body: JSON:

  Code Block
  { "status" : "" "details" : "" }

Get Restore Details

• Purpose: Provides the status of a restoration action
• Request: GET https://host:port/bridge/restore/(restoreId)

  • restoreId - Identifier of the restoration

• Response Code: 200 (on success)

• Response Body: JSON:

  Code Block
  { "restoreId" : "", "snapshotId" : "", "status" : "", "startDate" : "", "endDate" : "", "statusText" : "", "destinationHost" : "", "destinationPort" : "", "destinationStoreId" : "", "destinationSpaceId" : "" }

  Possible values for status:

  • INITIALIZED

  • WAITING_FOR_DPN

  • DPN_TRANSFER_COMPLETE

  • TRANSFERRING_TO_DURACLOUD

  • TRANSFER_TO_DURACLOUD_COMPLETE

  • VERIFYING_TRANSFERRED_CONTENT

  • CLEANING_UP

  • ERROR

  • RESTORATION_COMPLETE

Restart Restore

• Purpose: Enables restart of restores that failed to transfer successfully to DuraCloud.
• Request: POST https://host:port/bridge/restore/(restoreId)/restart
  • restoreId - Identifier of the restore

• Request Body: JSON:

  Code Block
  {}

  •  

• Response Code: 202 (on success)

• Response Body: JSON:

  Code Block
  { "status" : "DPN_TRANSFER_COMPLETE", "description" : "" }

Cancel Restore

• Purpose: Enables cancellation of a restore that is underway. Calls to this method will fail if the restore is in the CLEANING_UP or COMPLETE states.
• Request: POST https://host:port/bridge/restore/(restoreId)/cancel
  • restoreId - Identifier of the restoreId

• Request Body: JSON:

  Code Block
  {}

  •  

• Response Code: 200 (on success)

• Response Body: JSON:

  Code Block
  { "status" : "CANCELLED", "description" : "" }