Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleGeneral Operations

Initialize

  • Purpose: Provides all information needed to initialization the Bridge Ingest App
  • Request:  POST https://host:port/snapshotbridge/init
  • Request Body: JSON in format:

    Code Block
    {
     "originatorEmailAddress" : "${snapshotbridge.originatorEmailAddress}",
     "duracloudEmailAddresses" : ["${snapshotbridge.duracloudEmailAddress}"],
     "dpnEmailAddresses" : ["${snapshotbridge.dpnEmailAddress}"],
     "duracloudUsername" : "${snapshotbridge.duracloudUsername}",
     "duracloudPassword" : "${snapshotbridge.duracloudPassword}",
     "awsAccessKey" : "${aws.accessKey}",
     "awsSecretKey" : "${aws.secretKey}",
     "databaseUser" : "${snapshotbridge.database.username}",
     "databasePassword" : "${snapshotbridge.database.password}",
     "databaseURL" : "${snapshotbridge.database.url}",
     "contentDirRoot" : "${snapshotbridge.contentDirRoot}",
     "workDir" : "${snapshotbridge.workDir}",
     "clean" : "${snapshotbridge.clean}"
    }
  • Response Code: 200 (on success)
  • Response Body: JSON:

    Code Block
    {"message" : "success!"}

Version

  • Purpose: Provides the current version of the Bridge Ingest App
  • Request: GET https://host:port/snapshotbridge/version
  • Response Code: 200 (on success)
  • Response Body: JSON:

    Code Block
    {"version" : "1.0.0"}
Panel
titleIngest Operations
Take

Create Snapshot

  • Purpose: Performs a snapshot action
  • Request: POST https://host:port/snapshot/(host)/(port)/(storeID)/(spaceID)/(snapshotID)bridge/snapshots
  • Request Body:

    Code Block
    {
     "host" : "",
     "port" : "",
     "storeId" : "",
     "spaceId" : ""
    } 
    • 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
    • snapshotID - Identifier of the snapshot
  • Response Code: 200 (on success)
  • Response Body: JSON:

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

List All Snapshots

Snapshot Status

Panel
titleRestore Operations

Restore Snapshot

 

 

Code Block
{"status" : ""}

 

Restore

Status

Complete

 

  • Purpose: Provides the status of a snapshot actionEnables DPN provider to notify bridge app that a snapshot has been restored to bridge storage.
  • Request: GETPOST https://host:port/snapshotbridge/snapshots/(snapshotID)/restore/complete
  • snapshotID - Identifier of the snapshot
  • Response Code: 200 (on success)
  • Response Body: JSON:

 

 

Code Block
{"status" : ""}