Page History

Create Snapshot

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

• Request Body:

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

  • 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
    
    
• 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: Performs a snapshot action
• Request: GET https://host:port/snapshot/snapshots

• Request Body:

• Response Body: JSON:

  Code Block
  [ {"id":"snapshot1", "description"}, "snapshot2"..., "snapshot3"... ]

Snapshot Status

• Purpose: Provides the status of a snapshot action
• Request: GET https://host:port/snapshot/snapshots/(snapshotId)?host=&port=
  • snapshotID - Identifier of the snapshot
  • host
  • port
• 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/snapshot/snapshots/(snapshotID)/dpn-transfer-complete
• 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: POST https://host:port/snapshot/

  snapshots/(snapshotID)/restore

  restorations

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

  snapshotID - Identifier of the snapshot

• Response Code: 200 (on success)

• Response Body: JSON:

• Code Block
  {"

• restorationId" : ""}

   

Restore Complete

• Purpose: Enables DPN provider to notify bridge app that a snapshot has been restored to bridge storage.
• Request: POST https://host:port/snapshot/snapshotsrestorations/(snapshotIDrestorationId)/restore/complete
• snapshotID - 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/snapshot/restorations/(restorationId)
• Response Code: 200 (on success)

• Response Body: JSON:

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

• Possible values for status:

  • WAITING_FOR_DPN_TRANSER
  • TRANSFER_TO_BRIDGE_COMPLETE
  • TRANSFER_TO_DURACLOUD_COMPLETE
  • VERIFYING
  • COMPLETE