Page History

Create Snapshot

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

• 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
  { "snapshotId" : "", "status": "" }

List All Snapshots

• Purpose: Retrieves a list of all snapshots

• Request: GET https://host:port/bridge/snapshot ? host=(host)

• Response Body: JSON:

  Code Block
  { "snapshots" : [ { "snapshotId" : "", "description" : "", "status" : "" }, ..., ... ] }

List Snapshot Contents

• Purpose: Retrieves a list of content items which were included in a snapshot

• Request: GET https://host:port/bridge/snapshot/(snapshotId)/content ? page=(pageNumber) & pageSize=(pageSize) & prefix=(prefix)

• Response Body: JSON:

  Code Block
  {  "contentItems" : [ { "contentId" : "", "contentProperties" : {"" : ""} } ] }

Get Snapshot

Details

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

• Response Body: JSON:

  Code Block
  { "snapshotId" : "", "snapshotDate" : "", "status" : "", "sourceHost" : "", "sourceSpaceId" : "", "subStatussourceStoreId" : "", "description" : "", "contentItemCount" : "", "detailstotalSizeInBytes" : "" }

  Possible values for status:

  • INITIALIZED

  • TRANSFERRING_

    TO

    FROM_

    BRIDGE

    DURACLOUD

  • WAITING_FOR_DPN

    _TRANSER
  • TRANSFERING_TO_DPN

  • CLEANING_UP

  • SNAPSHOT_COMPLETE

  • FAILED_TO_TRANSFER_FROM_DURACLOUD

    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/(snapshotId)/complete
• snapshotId - Identifier of the snapshot
• Response Code: 200 (on success)

• Response Body: JSON:

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