Page History

Create Snapshot

• Purpose: Performs a snapshot action
• Request: PUT https://host:port/bridge/snapshot/(snapshotNamesnapshotId)

• Request Body: JSON:

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

  • host - DNS host of DuraCloud instance from which snapshot can be taken
  • port - Port on which DuraCloud applications are available
  • storeID - Identifier of Chronopolis staging storage provider on DuraCloud instance
  • spaceID - Identifier of space in which snapshot content resides
  • description - User-supplied description of the snapshot
  • userEmail - User's email address, for notifications
    
    
• Response Code: 200 or 201 on success (201 if snapshot request did not already exist)

• Response Body: JSON:

  Code Block
  { "snapshotNamesnapshotId" : "", "status": "" }

List All Snapshots

• Purpose: Performs a snapshot action

• Request: GET https://host:port/bridge/snapshot

• Request Header: source-host=[hostname]

• Response Body: JSON:

  Code Block
  [ {"snapshotNamesnapshotId":"snapshot1", "description"}, ..., ... ]

Snapshot Status

• Purpose: Provides the status of a snapshot action
• Request: GET https://host:port/bridge/snapshot/(snapshotNamesnapshotId)
  • snapshotName snapshotId - Identifier of the snapshot
• Response Code: 200 (on success)

• Response Body: JSON:

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

  Possible values for status:

  • TRANSFERRING_TO_BRIDGE
  • WAITING_FOR_DPN_TRANSER
  • TRANSFERING_TO_DPN
  • COMPLETE

Snapshot Complete

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

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" : "", "snapshotNamesnapshotId" : "", "userEmail" : "" }

• Response Code: 200 (on success)

• Response Body: JSON:

  Code Block
  {"id" : ""}

   

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 snapshot
• Response Code: 200 (on success)

• Response Body: JSON:

  Code Block
  {"status" : ""}

Restoration Status

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

• Response Body: JSON:

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

  Possible values for status:

  •     INITIALIZED
  •     WAITING_FOR_DPN
  •     DPN_TRANSFER_COMPLETE
  •     TRANSFERRING_TO_DURACLOUD
  •     VERIFYING_TRANSFERRED_CONTENT
  •     RESTORATION_COMPLETE