...
Panel |
---|
title | Audit Log REST Methods |
---|
|
Get Audit Log- Purpose: Allows the initialization of storage provider accounts Returns the latest audit for a given store and space
- Request:
GET https://host:port/durastore/audit/{storeId}/{spaceId} Response Code: 200 (on success), 404 if audit logs were not found. Response Body: TSV in chronological order with the following fields. Code Block |
---|
| ACCOUNT STORE_ID SPACE_ID CONTENT_ID CONTENT_MD5 CONTENT_SIZE CONTENT_MIMETYPE CONTENT_PROPERTIES SPACE_ACLS SOURCE_SPACE_ID SOURCE_CONTENT_ID TIMESTAMP ACTION USERNAME
mysubdomain 51 myspace image-01.jpg b1978f9fc4fe9448e05b83bbe6b98109 81214 image/jpeg {"content-mimetype" : "image/jpeg"} {} 2014-09-10T15:54:42.042 ADD_CONTENT root |
|
Panel |
---|
title | Manifest REST Methods |
---|
|
Get Manifest- Purpose: Allows the initialization of storage provider accountsReturns the latest manifest for a given space and storeId
- Request:
GET https://host:port/durastore/manifest/{spaceId}?storeID={storeID}&format={format} - Optional parameter 'format': TSV or BAGIT. TSV is default.
Response Code: 200 (on success), 404 if manifest was empty found. Response Body: TSV in chronological order with the following fields. Code Block |
---|
| ACCOUNT STORE_ID SPACE_ID CONTENT_ID CONTENT_MD5 CONTENT_SIZE CONTENT_MIMETYPE CONTENT_PROPERTIES SPACE_ACLS SOURCE_SPACE_ID SOURCE_CONTENT_ID TIMESTAMP ACTION USERNAME
mysubdomain 51 myspace image-01.jpg b1978f9fc4fe9448e05b83bbe6b98109 81214 image/jpeg {"content-mimetype" : "image/jpeg"} {} 2014-09-10T15:54:42.042 ADD_CONTENT root |
|
Panel |
---|
title | Audit Log REST Methods |
---|
|
Get Audit Log
Purpose: Allows the initialization of storage provider accountsRequest: GET https://host:port/durastore/audit/{storeId}/{spaceId}
Response Code: 200 (on success), 404 if audit log does not exist or is empty.
Response Body: TSV in chronological order with the following fields.
Code Block |
---|
xml | xml | ACCOUNT STORE_ID SPACE_ID CONTENT_ID CONTENT_MD5 CONTENT_SIZE CONTENT_MIMETYPE CONTENT_PROPERTIES SPACE_ACLS SOURCE_SPACE_ID SOURCE_CONTENT_ID TIMESTAMP ACTION USERNAME
mysubdomain 51 myspace image-01.jpg b1978f9fc4fe9448e05b83bbe6b98109 81214 image/jpeg {"content-mimetype" : "image/jpeg"} {} 2014-09-10T15:54:42.042 ADD_CONTENT root |
Panel |
---|
title | Manifest REST Methods |
---|
|
Get Manifest
Purpose: Allows the initialization of storage provider accountsRequest: GET https://host:port/durastore/manifest/{spaceId}?storeID={storeID}&format={format}
Optional parameter 'format': TSV or BAGIT. TSV is default.Response Code: 200 (on success), 404 if manifest is empty or does not exist.
Response Body: TSV in chronological order with the following fields.
Code Block |
---|
xml | xml | ACCOUNT STORE_ID SPACE_ID CONTENT_ID CONTENT_MD5 CONTENT_SIZE CONTENT_MIMETYPE CONTENT_PROPERTIES SPACE_ACLS SOURCE_SPACE_ID SOURCE_CONTENT_ID TIMESTAMP ACTION USERNAME
mysubdomain 51 myspace image-01.jpg b1978f9fc4fe9448e05b83bbe6b98109 81214 image/jpeg {"content-mimetype" : "image/jpeg"} {} 2014-09-10T15:54:42.042 ADD_CONTENT root |
Panel |
---|
|
Info |
---|
Tasks are used to perform storage provider actions which cannot be performed in a generic manner across multiple providers. |
Get Tasks- Purpose: Performs a particular task. Note that most tasks can be performed by only one storage provider type.
- Request:
POST https://host:port/durastore/task/taskName ? (storeID) - Request Body: Parameters for task. Each task will expect parameters in a specific format, see task listing for more details.
- Response Code: 200 (on success)
- Response Body: Response value for task, format varies by task.
TasksAmazon S3 Storage ProvidertaskName | Name | Description | Request Body | Response Body |
---|
enable-streaming | Enable Streaming task | Enables RTMP streaming for all files within a DuraCloud space through the use of Amazon's Cloudfront streaming capability. This task may take up to 15 minutes to complete. | Name of the space for which streaming is to be enabled | Text indicating the results of the task, including the streaming host | disable-streaming | Disable Streaming task | Disables streaming by removing the ability for Cloudfront to access files within a space. This does not remove the streaming distribution, only disables its use, so enabling streaming on the same space again can be performed much more quickly. Some content in the space may continue to be available for streaming up to 24 hours after streaming has been disabled. | Name of the space for which streaming is to be disabled | Text indicating the results of the task | delete-streaming | Delete Streaming task | Removes a streaming distribution created by the enable-streaming task. This task should be performed after performing the disable-streaming task. This task may take up to 15 minutes to complete, after which no content in the space will be available for streaming. | Name of the space for which streaming is to be deleted | Text indicating the results of the task | noop | Test task | Provides a simple way to test the calling of tasks | Body content is ignored | Text indicating successful task completion |
Amazon Glacier Storage ProvidertaskName | Name | Description | Request Body | Response Body |
---|
restore-content | Restore Content task | Provides the capability to request that specific content items stored in Glacier be retrieved. Content items which are retrieved are made available 3-5 hours after this request is made, and remains available for 2 weeks. | Name of the space and the content item in the form: spaceID/contentID | Text indicating that a restore action has been initiated (or that a restore is already in progress, in the case of duplicate requests.) |
Snapshot Storage ProvidertaskName | Name | Description | Request Body | Response Body |
---|
create-snapshot | Create Snapshot task | Creates a snapshot by collecting details of the snapshot and passing the request down to a bridge application which makes a copy of the contents of the space. | No Format |
---|
{
"spaceId" : "",
"description" : "",
"userEmail" : ""
} |
| No Format |
---|
{
"snapshotId" : "",
"status" : ""
} |
| get-snapshot | Get Snapshot task | Retrieves the status and details of a snapshot action | No Format |
---|
{
"snapshotId" : ""
} |
| No Format |
---|
{
"snapshotId" : "",
"snapshotDate" : "",
"status" : "",
"sourceHost" : "",
"sourceSpaceId" : "",
"sourceStoreId" : "",
"description" : "",
"contentItemCount" : "",
"totalSizeInBytes" : ""
} |
| cleanup-snapshot | Clean Up Snapshot task | Handles the removal of content items in a space after a snapshot has taken place | No Format |
---|
{
"spaceId" : ""
} |
| No Format |
---|
{
"contentExpirationDays" : ""
} |
| complete-snapshot | Complete Snapshot task | Completes the snapshot process | No Format |
---|
{
"spaceId" : ""
} |
| No Format |
---|
{
"result" : ""
} |
| get-snapshots | Get List of Snapshots task | Retrieves a listing of all snapshots which have been created | None | No Format |
---|
{
"snapshots" : [
{
"snapshotId" : "",
"description" : "",
"status" : ""
},
...,
...
]
} |
| get-snapshot-contents | Get List of Snapshot Contents task | Retrieves a listing of the contents of a particular snapshot | No Format |
---|
{
"snapshotId" : "",
"pageNumber" : 0,
"pageSize" : 1000,
"prefix" : ""
} |
| No Format |
---|
{
"totalCount" : 0,
"contentItems" :
[{
"contentId" : "",
"contentProperties" :
{
"" : ""
}
}]
} |
| restore-snapshot | Restore Snapshot task | Requests that a snapshot be restored to a DuraCloud space | No Format |
---|
{
"snapshotId" : "",
"userEmail" : ""
} |
| No Format |
---|
{
"spaceId" : "",
"restoreId" : "",
"status" : ""
} |
| get-restore | Get Snapshot Restore | Retrieves the status and details of a restore action | No Format |
---|
{
"snapshotId" : "",
"restoreId" : ""
} |
| No Format |
---|
{
"restoreId" : "",
"snapshotId" : "",
"status" : "",
"startDate" : "",
"endDate" : "",
"statusText" : "",
"destinationHost" : "",
"destinationPort" : "",
"destinationStoreId" : "",
"destinationSpaceId" : ""
} |
|
|
...