Page History

...

...

DuraStore

Purpose: DuraStore is the application through which DuraCloud manages storage. The DuraStore REST API provides access to storage by mediating the underlying storage provider APIs to allow access to multiple cloud storage options through a single API.

DuraStore

Purpose: DuraStore is the application through which DuraCloud manages storage. The DuraStore REST API provides access to storage by mediating the underlying storage provider APIs to allow access to multiple cloud storage options through a single API.

Is Initialized

• spaceID ? (storeID) (prefix) (maxResults) (marker)
  
  • storeID (optional) - ID of the content storage provider to query (default is primary store)
  • prefix (optional) - Only retrieve content ids with this prefix (default is all content ids)
  • maxResults (optional) - The maximum number of content IDs to return in the list (default is 1000)
    note: the maximum allowable value for maxResults is 1000. Any larger value will be reduced to 1000.
  • marker (optional) - The content ID marking the last item in the previous set (default is the first set of ids)
• Response Code:
  • 200 (on success)
  • 404 (if the the given space does not exist)

• Response Body: XML similar to:

<durastoreConfig>
  <storageAudit>
    <auditUsername>audit-username</auditUsername>
    <auditPassword>audit-password</auditPassword>
    <auditQueue>audit-queue-name</auditQueue>
    <auditLogSpaceId>audit-log-space-id</auditLogSpaceId>
  </storageAudit>
  <millDb>
    <name>db-name</name>
    <host>db-host</name>
    <port>db-port</name>
    <username>db-username</username>
    <password>db-password</password>
  </millDb>
  <storageProviderAccounts>
    <storageAcct ownerId='0' isPrimary='true'>
      <id>1</id>
      <storageProviderType>AMAZON_S3</storageProviderType>
      <storageProviderCredential>
        <username>username</username>
        <password>password</password>
      </storageProviderCredential>
      <storageProviderOptions>
        <!-- Provider specific details -->
      </storageProviderOptions>
    </storageAcct>
  </storageProviderAccounts>
</durastoreConfig>

<space id="space1">
  <item>Image 1</item>
  <item>Image 2</item>
</space>

x-dura-meta-space-count: 65
x-dura-meta-space-created: 2016-04-14T01:40:47

Get Space Properties

• Purpose: Provides all space properties
• Request: HEAD https://host:port/durastore/spaceID ? (storeID)
• Response Code:
  • 200 (on success)
  • 404 (if the the given space does not exist)
• Response Headers: Same as for Get space (above)

Create Space

• Purpose: Creates a new space
• Request: PUT https://host:port/durastore/spaceID ? (storeID)

• Response Code: 

  • 201 (on success)

  • 400 (if the content ID is invalid)

• Response Headers: Location of the new space (i.e. the URL used to create the space), example:

  Code Block
  language bash
  Location: https://myhost:8080/durastore/space1

  
  

Delete Space

• Purpose: Deletes a space
• Request: DELETE https://host:port/durastore/spaceID ? (storeID)
• Response Code:
  • 200 (on success)
  • 404 (if the the given space does not exist)
• Response Body: "Space $spaceID deleted successfully" (on success)

Get Space ACLs

• Purpose: Provides all space ACLs, with values of 'r' (read) and 'w' (read/write)
• Request: HEAD
• Purpose: Performs a check to determine if the DuraStore application has been initialized
• Request: GET https://host:port/durastore/init/acl/spaceID ? (storeID)
• Response Code:
  • 200 (
  if the application has been initialized), 503 (if the application has NOT been initialized)
• Response Body: Text indicating whether initialization has occurred.

• • on success)
  • 404 (if the the given space does not exist)

• Response Headers: All available space ACLs, example:

  Code Block
  language none
  x-dura-meta-acl-user0: WRITE x-dura-meta-acl-user1: WRITE x-dura-meta-acl-group-curators: READ

  
  

Set Space ACLs

• Purpose: Updates the ACLs associated with a space
• Request: POST https:

Get Stores

• Purpose: Provides a listing of available storage providers accounts (without credentials)
• Request: GET https://host:port/durastore/stores
• Parameters: None
• Response Code: 200 (on success)

Response Body: XML similar to:

Code Blockxmlxml

<storageProviderAccounts>
  <storageAcct isPrimary='true'>
    <id>1</id>
    <storageProviderType>AMAZON_S3</storageProviderType>
  </storageAcct>
  <storageAcct isPrimary="false">
    <id>2</id>
    <storageProviderType>RACKSPACE</storageProviderType>
  </storageAcct>
</storageProviderAccounts>

• acl/spaceID ? (storeID)

• Request Headers: For 'user' ACLs the header prefix must be 'x-dura-meta-acl-' and for 'groups' the header prefix must be 'x-dura-meta-acl-group-'. Allowable values for ACL headers are: 'READ' and 'WRITE'.
  Example:

  Code Block
  language none
  x-dura-meta-acl-user0: WRITE x-dura-meta-acl-user1: WRITE x-dura-meta-acl-group-curators: READ

  
  

• Response Code:
  • 200 (on success)
  • 404 (if the the given space does not exist)
• Response Body: "Space $spaceID ACLs updated successfully" (on success)

*

x-dura-meta-

• • content-mimetype (set Content-Type header instead) x-dura-meta

• • -content-size (automatically written as Content-Length header) x-dura-meta-

Delete Space

• Purpose: Deletes a space
• Request: DELETE https://host:port/durastore/spaceID ? (storeID)
• Response Code: 200 (on success)
• Response Body: "Space $spaceID deleted successfully" (on success)

• • • content-checksum (automatically written as Content-MD5 header) x-dura-meta-content-modified (automatically written as Last-Modified header)

      
      

    • Headers used by the DuraCloud SyncTool to automatically capture file details

      Code Block
      x-dura-meta-creator x-dura-meta-content-file-created x-dura-meta-content-file-modified x-dura-meta-content-file-last-accessed x-dura-meta-content-file-path

      
      

  • Use only US-ASCII characters for property names and values

  • There is a 2 KB total size limit on all content properties (this includes both auto-generated and user contributed properties.)

  • The "x-dura-meta-" prefix is case-sensitive (make sure your clients do not automatically change case.)

Copy Content

• Purpose: Copies a piece of content from a source space to a destination space within a given store
• Request: PUT

Get Content

• Purpose: Retrieves a piece of content along with its properties
• Request: GET https://host:port/durastore/spaceID/contentID contentID ? (storeID) (attachment)
  
  • if attachment param value is true, a Content-Disposition header is included with the response
• Response Code: 200 (on success)
• Response Body: The content stream
• Request Body: must not exist

• Request Headers: Copy sourceResponse Headers: All available content properties, example:

  Code Block
  language none
  x-dura-meta-copy-source: space-id/content-id

  
  

• Optional Request Headers: Copy source store, example:

  Code Block
  language none
  Content-Type: text/plain Content-Length: 5732 Content-MD5: 3456709234785097473839202 ETag: 3456709234785097473839202 x-dura-meta-content-name: Testing Content x-dura-meta-content-owner: JSmith

Get Content Properties

• Purpose: Retrieves the properties of a piece of content without the content itself
• Request: HEAD https://host:port/durastore/spaceID/contentID ? (storeID)

  copy-source-store: storeId

  
  

• Response Code: 200 201 (on success)
• Response Headers: Same as Get content (above)

Store Content

• 
  
  • MD5 checksum of stored content
  • ETag of stored content

  • Location of the new content (i.e. the URL used to create the content)

• Purpose: Adds a piece of content to the store
• Request: PUT https://host:port/durastore/spaceID/contentID ? (storeID)
• Request Body: Content to be added
• Request Headers: Properties about the content

  • , example:

    Code Block
    language

  noneContent-Type: text/plain

  • bash

    Content-MD5: 4cd56e137a93a1accb43c5d32f4afffb

  x-dura-meta-content-name

  • ETag:

  Testing Content x-dura-meta-content-owner: JSmith
• Response Code:
  
  • 201 (on success)
  • 400 (if the content ID is invalid)
  • 404 (if the the given space does not exist)
  • 409 (if the provided checksum did not match the stored content checksum)
  • 500 (on error)
• Response Headers:
  
  • MD5 checksum of stored content
  • ETag of stored content

  • Location of the new content (i.e. the URL used to create the content), example:

    Code Block
    language bash
    Content-MD5: 4cd56e137a93a1accb43c5d32f4afffb ETag: 4cd56e137a93a1accb43c5d32f4afffb Location: https://myhost:8080/durastore/space1/content1

• Usage Notes
  
  • When the optional Content-MD5 header is included, the final checksum of the stored file is compared against the MD5 value included in the header to ensure that the file was stored correctly. If the header is not included, an MD5 checksum is computed as the file is transferred to storage, and that value is used in the final comparison.

Copy Content

• • 4cd56e137a93a1accb43c5d32f4afffb Location: https://myhost:8080/durastore/space1/content1

    
    

• Usage Notes
  
  • The properties associated with the source content item are copied to the destination content item.
  • The source and destination spaces may be the same.
  • Including the optional header indicates that the copy action should retrieve the source file from a space in the specified storage provider. This allows for copying a file from one storage provider to another.

Set Content Properties

• Purpose: Updates the properties associated with a piece of content. Note: You must include ALL properties you would like associated with the given content item in this call. Any properties that exist before this call but are not included in the call itself will be removed. This is to allow for both adding and removing properties.
• Request: POST https://host:port/durastore/spaceID/contentID ? (storeID)
• Request Headers: Same as Store content (above)
• Response Code: 200 (on success)
• Response Body: "Content $contentID updated successfully"

Delete Content

• Purpose: Removes a piece of content from the store
• Request: DELETE
• Purpose: Copies a piece of content from a source space to a destination space within a given store
• Request: PUT https://host:port/durastore/spaceID/contentID ? (storeID)
• Request Body: must not exist

• Request Headers: Copy source, example:

  Code Block
  language none
  x-dura-meta-copy-source: space-id/content-id

• Optional Request Headers: Copy source store, example:

  Code Block
  language none
  x-dura-meta-copy-source-store: storeId

• Response Code: 201 (on success)
• Response Headers:
  
  • MD5 checksum of stored content
  • ETag of stored content

  • Location of the new content (i.e. the URL used to create the content), example:

    Code Block
    language bash
    Content-MD5: 4cd56e137a93a1accb43c5d32f4afffb ETag: 4cd56e137a93a1accb43c5d32f4afffb Location: https://myhost:8080/durastore/space1/content1

• Usage Notes
  
  • The properties associated with the source content item are copied to the destination content item.
  • The source and destination spaces may be the same.
  • Including the optional header indicates that the copy action should retrieve the source file from a space in the specified storage provider. This allows for copying a file from one storage provider to another.

Set Content Properties

• Purpose: Updates the properties associated with a piece of content. Note: You must include ALL properties you would like associated with the given content item in this call. Any properties that exist before this call but are not included in the call itself will be removed. This is to allow for both adding and removing properties.
• Request: POST https://host:port/durastore/spaceID/contentID ? (storeID)
• Request Headers: Same as Store content (above)
• Response Code: 200 (on success)
• Response Body: "Content $contentID updated successfully"

Delete Content

• Purpose: Removes a piece of content from the store
• Request: DELETE https://host:port/durastore/spaceID/contentID ? (storeID)
• Response Code: 200 (on success)
• Response Body: "Content $contentID deleted successfully"

• Response Code: 200 (on success)
• Response Body: "Content $contentID deleted successfully"

{
  "spaceId" : "",
  "secure" : ""
}

{
  "result" : "",
  "streamingHost" : ""
}

{
  "spaceId" : ""
}

{
  "result" : ""
}

{
  "spaceId" : ""
}

{
  "result" : ""
}

{
  "spaceId" : "",
  "contentId" : "",
  "resourcePrefix" : ""
}

{
  "streamUrl" : ""
}

{
  "spaceId" : "",
  "contentId" : "",
  "minutesToExpire" : "",
  "ipAddress" : ""
  "resourcePrefix" : ""
}

{
  "signedUrl" : ""
}

{
  "spaceId" : "",
  "storageClass" : "",
  "daysToTransition" : 0
}

{
  "result" : ""
}

{
  "spaceId" : "",
  "secure" : ""
}

{
  "spaceIdresult" : "",
  "descriptionstreamingHost" : "",
  "userEmail" : ""
}

{
  "snapshotId" : "",
  "status" : ""
}

}

{
  "

spaceId" : ""

}

{
  "

result" : ""

}

{
  "

spaceId" : ""

}

{
  "

result" : ""
}

{,
  "contentItemCountspaceId" : "",
  "totalSizeInBytescontentId" : "",
  "alternateIdsresourcePrefix" :
    ["" , ""]    
}

{
  "contentExpirationDaysstreamUrl" : ""
}

{
  "spaceId" : "",
  "contentId" : ""
}

{,
  "minutesToExpire" : "",
  "resultipAddress" : ""
}

{
  "spaceIdresourcePrefix" : ""
}

{
  "result" : "text description of result"
}

{
  "snapshotId" : ""  
}

{
  "snapshotId" : "",
  "status" : ""
}

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

{
  "signedUrl

{
  "snapshotId" : "",
  "pageNumber" : 0,
  "pageSize" : 1000,
  "prefix" : ""
}

{ 
  "totalCount" : 0,
  "contentItems" : 
  [{ 
    "contentId" : "",
    "contentProperties" : 
      {
        "" : ""
      }
  }]
}

}

{
  "snapshotIdspaceId" : "",
  "pageNumberstorageClass" : 0"",
  "pageSizedaysToTransition" : 0
}

{
  "totalCount" : 0,
  "historyItems" : 
  [{ 
    "history" : "",
    "historyDate" : 0
  }]
}

{
  "snapshotIdresult" : "",
  "userEmail" : ""
}

{
  "description" : ""
}

}

{
  "snapshotId" : "",
  "userEmail" : ""
}

{
  "spaceId" : "",
  "restoreId" : "",
  "status" : ""
}

{
  "spaceId"

 : "",
  "

description" : 

"",
  "

userEmail" : 

""
}

{
  "snapshotId" : "",
  "status" : ""
}

{
  "restoreIdsnapshotId" : ""
}

{
  "snapshotId" : "",
  "restoreIdsnapshotDate" : "",
  "status" : "",
  "sourceHost" : "",
  "snapshotIdsourceSpaceId" : "",
  "statussourceStoreId" : "",
  "startDatedescription" : "",
  "endDatecontentItemCount" : "",
  "statusTexttotalSizeInBytes" : "",
  "destinationHostalternateIds" :
    ["" , ""]    
}

{
  "destinationPortspaceId" : "",
}

{
  "destinationStoreIdcontentExpirationDays" : "",""
}

{
  "destinationSpaceIdspaceId" : ""
}

DurAdmin

Purpose: DurAdmin is the user-facing application through which DuraCloud exposes DuraStore and DuraService functionality. The DurAdmin REST API provides the means by which DurAdmin is initialized.

...

Initialize Application

...

Request Body: XML similar to:

...

<duradminConfig>
  <durastoreHost>[host]</durastoreHost>
  <durastorePort>[port]</durastorePort>
  <durastoreContext>durastore</durastoreContext>
  <duraserviceHost>[host]</duraserviceHost>
  <duraservicePort>[port]</duraservicePort>
  <duraserviceContext>duraservice</duraserviceContext>
  <!--optional-->
  <millDbEnabled>[true or false]</millDbEnabled>
</duradminConfig>

...

Is Initialized

• Purpose: Performs a check to determine if the DurAdmin application has been initialized
• Request: GET https://host:port/duradmin/init
• Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
• Response Body: Text indicating whether initialization has occurred.

DuraBoss

Purpose: DuraBoss provides administrative control over a variety of activities that run over the storage managed by DuraCloud.

...

Initialize Application

...

Request Body: XML similar to:

...

<durabossConfig>
  <reporterEnabled>[true|false]</reporterEnabled>
  <durastoreHost>[host]</durastoreHost>
  <durastorePort>[port]</durastorePort>
  <durastoreContext>durastore</durastoreContext>
  <notificationConfig>
    <type>EMAIL</type>
    <username>[username for notification system]</username>
    <password>[password for notification system]</password>
    <originator>[from email address]</originator>
    <admin>[administrator email address]</admin>
  </notificationConfig>
</durabossConfig>

}

{
  "result" : ""
}

{
  "spaceId" : ""
}

{
  "result" : "text description of result"
}

{
  "snapshotId" : ""  
}

{
  "snapshotId" : "",
  "status" : ""
}

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

{
  "snapshotId" : "",
  "pageNumber" : 0,
  "pageSize" : 1000,
  "prefix" : ""
}

{ 
  "totalCount" : 0,
  "contentItems" : 
  [{ 
    "contentId" : "",
    "contentProperties" : 
      {
        "" : ""
      }
  }]
}

{
  "snapshotId" : "",
  "pageNumber" : 0,
  "pageSize" : 0
}

{
  "totalCount" : 0,
  "historyItems" : 
  [{ 
    "history" : "",
    "historyDate" : 0
  }]
}

{
  "snapshotId" : "",
  "userEmail" : ""
}

{
  "description" : ""
}

{
  "snapshotId" : "",
  "userEmail" : ""
}

{
  "spaceId" : "",
  "restoreId" : "",
  "status" : ""
}

{
  "spaceId" : "",                         
  "daysToExpire" : 1
}

{
  "result" : ""
}

{
  "snapshotId" : "",
  "restoreId" : ""
}

{
  "restoreId" : "",
  "snapshotId" : "",
  "status" : "",
  "startDate" : "",
  "endDate" : "",
  "statusText" : "",
  "destinationHost" : "",
  "destinationPort" : "",
  "destinationStoreId" : "",
  "destinationSpaceId" : ""
}

...

Is Initialized

• Purpose: Performs a check to determine if the DuraBoss application has been initialized
• Request: GET https://host:port/duraboss/init
• Response Code: 200 (if the application has been initialized), 503 (if the application has NOT been initialized)
• Response Body: Text indicating whether initialization has occurred.

...