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
GET https://host:port/bridge/snapshot ? host=/( hostsnapshotId)
host - Account host for which snapshot listing should be provided - snapshotId - Identifier of the snapshot
- Response Code: 200 (on success)
Response Body: JSON: Code Block |
---|
{
"snapshotssnapshotId" : ["",
"snapshotDate" : {"",
"status" : "",
"snapshotIdsourceHost" : "",
"sourceSpaceId" : "",
"descriptionsourceStoreId" : "",
"statusdescription" : "",
"contentItemCount" : }"",
"totalSizeInBytes" ...,
...
]
} |
List Snapshot ContentsSnapshot Complete- Purpose: Enables storage provider (Chronopolis) to notify bridge app that snapshot content has been successfully transferred to preservation storage and can now be removed from the bridge storage area (and DuraCloud)
- Request:
POST - 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" : {"" : ""}
}
]
} |
List Snapshot History- Purpose: Retrieves a list of content items which were included in a snapshot
- Request:
GET https://host:port/bridge/snapshot/(snapshotId)/history ? page=(pageNumber) & pageSize=(pageSize) - snapshotId - Identifier of the snapshot
- pageNumber - Page number of history set
- pageSize - Number of history items to return in a single response
- Response Body: JSON:
Code Block |
---|
{
"totalCount" : (Long) # of historyItems
"historyItems" : [
{ "historyDate" : (Long) epoch time,
"history" : "${history item string}"
},
]
} |
Get Snapshot DetailssnapshotId)/complete - snapshotId - Identifier of the snapshot
Request Body: JSON: Code Block |
---|
{
"alternateIds": ["alternate-id-1", "alternate-id-2"]
} |
- Response Code: 200 (on success)
Response Body: JSON: Code Block |
---|
{
"status" : "SNAPSHOT_COMPLETE",
"details" : ""
} |
Snapshot ErrorSnapshot CompleteRestart Snapshot- Purpose: Enables restart of snapshots that failed to transfer successfully from DuraCloud.
- Request:
POST https://host:port/bridge/snapshot/(snapshotId)/restart - snapshotId - Identifier of the snapshot
Request Body: JSON: - Response Code: 202 (on success)
Response Body: JSON: Code Block |
---|
{
"status" : "INITIALIZED",
"description" : ""
} |
Cancel SnapshotSnapshot Error- Purpose: Enables DPN provider to notify bridge app that processing of the snapshot has resulted in an error
- Request:
POST https://host:port/bridge/snapshot/(snapshotId)/error - snapshotId - Identifier of the snapshot
Request Body: JSON: Code Block |
---|
{
"error": ""
} |
- Response Code: 200 (on success)
Response Body: JSON: Code Block |
---|
{
"status" : "SNAPSHOT_ERROR",
"details" : ""
} |
Restart SnapshotSnapshot History Update- Purpose: Enables storage provider (Chronopolis) to notify bridge app that a snapshot has an "update" to its history. Whether a snapshot was replicated, successfully stored, checksumed, etc... this is the REST call to handle any and all updates to the history of a particular Snapshot.
- Request:
POST https://host:port/bridge/snapshot/(identifier)/ history - identifier - Either the snapshot ID or an alternate ID (such as a bag ID) which was associated with the snapshot in the Snapshot Complete call
Request Body: JSON: - Parameters
- 'history' - single escaped JSON string that can contain a JSON array of objects or strings - the history event we're trying to record
- 'alternate' - whether the snapshot ID in the URL is the alternate ID or the original snapshot ID.
Preferred format (using name/value pairs) Code Block |
---|
{"history": "[ {'key1' : 'value1'},{'key2' : 'value2'} ]", "alternate": "false"} |
Alternative formats (also supported, but UI display may not be ideal) Code Block |
---|
{"history": "[ 'value1', 'value2' ]", "alternate": "false"}
OR
{"history": "[ {'key1': 'value1'}, 'value2' ]", "alternate": "false"}
OR
{"history": "value1", "alternate": "false"} |
- Response Code: 200
- Purpose: Enables restart of snapshots that failed to transfer successfully from DuraCloud.
- Request:
POST https://host:port/bridge/snapshot/(snapshotId)/restart - snapshotId - Identifier of the snapshot
Request Body: JSON: - Response Code: 202 (on success)
Response Body: JSON: Code Block |
---|
{
"statussnapshot" : "INITIALIZED"{SnapshotSummary},
"descriptionhistory" : "${the history string that was just inserted}"
} |
Cancel Snapshot |