Page History

Get Content

• Purpose: Retrieves a piece of content along with its properties
• Request: GET https://host:port/durastore/spaceID/contentID ? (storeID) (attachment)
  
  • if attachment param value is true, a Content-Disposition header is included with the response

• Request Headers: Range of bytes to retrieve from the file (optional) (Available in DuraCloud v5.0.0+)

  Code Block
  Range:bytes=byte_range

  
  

  • Value of Range header must begin with "bytes=" followed by the byte range

  • Only 1 byte range is supported per request, all ranges specified beyond the first are discarded

  • Examples of valid Range header values:
    • bytes=0-499 (retrieves the first 500 bytes from a file)
    • bytes=500-999 (retrieves the second 500 bytes from a file)
    • bytes=1000- (retrieves all bytes starting with 1000 to the end of the file)
• Response Code:
  • 200 (on success, for a complete file)
  • 206 (on success, for a range-limited set of bytes in the file)
  • 400 (on invalid request, such as if a Range header includes an invalid value)
• Response Body: The content stream

• Response Headers: All available content properties, 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)
• Response Code: 200 (on success)
• Response Headers: Same as Get content (above)

Store 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 none
  Content-Type: text/plain Content-MD5: 4cd56e137a93a1accb43c5d32f4afffb x-dura-meta-content-name: 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.
  • All properties to be set must be included as a request header with the prefix "x-dura-meta-". Any header using the "x-dura-meta-" prefix will be stored as a content property, with a few exceptions, which are used for specific other purposes:

    • Headers used as part of the Copy Content request

      Code Block
      x-dura-meta-copy-source x-dura-meta-copy-source-store

      
      

    • Headers used to provide details about a space (these cannot be set)

      Code Block
      x-dura-meta-space-count x-dura-meta-space-created

      
      

    • Headers used as part of the Set Space ACLs call (the * is replaced by the user or group name)

      Code Block
      x-dura-meta-acl-* x-dura-meta-acl-group-*

      
      

    • Headers used internal to DuraCloud

      Code Block
      x-dura-meta-content-mimetype (set Content-Type header instead) x-dura-meta-content-size (automatically written as Content-Length header) x-dura-meta-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 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"

Get Streaming Cookies

• Purpose: To be used in conjunction with secure HLS streaming in order to allow for setting access cookies on the user's browser. This endpoint is not called directly but is accessed by using the streaming distribution domain as a proxy, thus allowing cookies associated with that domain to be set. The response headers set the cookies. The body of the response is an HTML document which redirects the user. Expected to be used in combination with the get-signed-cookies-url S3 Task.
• Request: GET https://host:port/durastore/aux/cookies ? (token)
  • token - Token generated when cookie data is stored

• Response Code: 200 (on success), 404 if the specified token does not exisst

• Response Headers: 3 Set-Cookie headers (CloudFront-Policy, CloudFront-Signature, CloudFront-Key-Pair-Id)

Get Tasks

• Purpose: Provides a listing of all of the supported tasks for a given provider. Note that if no storeID parameter is included, the task listing is provided for the primary storage provider.
• Request: GET https://host:port/durastore/task ? (storeID)
• Response Code: 200 (on success)

• Response Body: XML similar to:

  Code Block
  language html/xml
  <list> <string>task1</string> <string>task2</string> </list>

  
  

Perform Task

• 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.

Tasks

Amazon S3 Storage Provider

HTTP Live Streaming support

{
  "spaceId" : "",
  "secure" : "",
  "allowedOrigins" : ["",""]
}

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

{
  "spaceId" : ""
}

{
  "result" : ""
}

{
  "spaceId" : ""
}

{
  "result" : ""
}

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

{
  "streamUrl" : ""
}

{
  "spaceId" : "",
  "minutesToExpire" : "",
  "ipAddress" : "",
  "redirectUrl" : ""
}

{
  "signedCookiesUrl" : ""
}

RTMP Streaming support (Deprecated as of DuraCloud 5.0.0)

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

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

{
  "spaceId" : ""
}

{
  "result" : ""
}

{
  "spaceId" : ""
}

{
  "result" : ""
}

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

{
  "streamUrl" : ""
}

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

{
  "signedUrl" : ""
}

Storage Policy support

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

{
  "result" : ""
}

Amazon Glacier Storage Provider

Snapshot Storage Provider

{
  "spaceId" : "",
  "description" : "",
  "userEmail" : ""
}

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

{
  "snapshotId" : ""
}

{
  "snapshotId" : "",
  "snapshotDate" : "",
  "status" : "",
  "sourceHost" : "",
  "sourceSpaceId" : "",
  "sourceStoreId" : "",
  "description" : "",
  "contentItemCount" : "",
  "totalSizeInBytes" : ""
  "alternateIds" :
    ["" , ""]    
}

{
  "spaceId" : ""
}

{
  "contentExpirationDays" : ""
}

{
  "spaceId" : ""
}

{
  "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" : ""
}