...
Info |
---|
Each of the methods below has specific security requirements. See DuraCloud Security for more information |
Warning |
---|
Due to an issue which does not properly handle requests redirected from http to https, it is recommended that all REST API requests use https directly. |
Tip |
---|
Examples calling the API defined below with the Unix utility "curl" can be found here |
...
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.
Panel |
---|
title | Security Initialization Store REST Methods |
---|
|
Initialize Security UsersGet Stores |
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.
</storageAcct>
</storageProviderAccounts> |
|
Panel |
---|
|
Get SpacesGet Space- Purpose: Provides a listing of the contents of a space along with space properties
- Request:
GET https://host:port/durastore/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
|
Panel |
---|
title | Initialization REST Methods |
---|
|
Initialize StoresIs InitializedGet Space Properties- Purpose: Provides all space properties
- Request:
HEAD - Purpose: Performs a check to determine if the DuraStore application has been initialized
- Request:
GET https://host:port/durastore/initspaceID ? (storeID) - Response Code:if the application has been initialized), 503 (if the application has NOT been initialized
- on success)
- 404 (if the the given space does not exist)
- Response Body: Text indicating whether initialization has occurred.
|
Panel |
---|
|
- Headers: Same as for Get space (above)
Create Space- Purpose: Creates a new space
- Request:
PUT
Get Stores |
Panel |
---|
|
Location: https://myhost:8080/durastore/space1 |
Delete Space- Purpose: Deletes a space
- Request:
DELETE
Get Spaces- Purpose: Provides a listing of all of the spaces that a customer has created
- Request:
GET https://host:port/durastore/spacesspaceID ? (storeID) - Response Code:
- 200 (on success)
- 404 (if the the given space does not exist)
- Response Body: XML similar to:
Code Block |
---|
| <spaces>
<space id="space1" />
<space id="space2" />
</spaces>
|
Get Space- "Space $spaceID deleted successfully" (on success)
Get Space ACLsGet Space PropertiesSet Space ACLs |
Panel |
---|
title | Content REST Methods |
---|
|
Get Content- Purpose: Retrieves a piece of content along with its properties
- Request:
GET https: - Purpose: Provides all space properties
- Request:
HEAD https://host:port/durastore/spaceID/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
- Purpose: Provides all space ACLs, with values of 'r' (read) and 'w' (read/write)
- Request:
HEAD https://host:port/durastore/acl/spaceID ? (storeID) - Response Code: 200 (on success)
Response Headers: Same as for Get space (above)
Get Space ACLsCreate SpaceGet Content Properties- Purpose: Creates a new spaceRetrieves the properties of a piece of content without the content itself
- Request:
PUT HEAD https://host:port/durastore/spaceID/contentID ? (storeID) - Response Code: 201 200 (on success)
- Response Headers: Location of the new space (i.e. the URL used to create the space), example:
Code Block |
---|
| Location: https://myhost:8080/durastore/space1 |
Set Space ACLs- : Same as Get content (above)
Store ContentDelete 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)
|
Panel |
---|
title | Content REST Methods |
---|
|
- 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:
- 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:
Get ContentGet 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 ContentCopy 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 |
---|
| x-dura-meta-copy-source: space-id/content-id
|
Optional Request Headers: Copy source store, example: Code Block |
---|
| x-dura-meta-copy-source-store: storeId
|
- Response Code: 201 (on success)
- Response Headers:
- 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
- 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"
|
Panel |
---|
|
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 |
---|
| x-dura-meta-copy-source: space-id/content-id
|
Optional Request Headers: Copy source store, example: Code Block |
---|
| x-dura-meta-copy-source-store: storeId
|
- Response Code: 201 (on success)
- Response Headers:
- 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)
Info |
---|
Tasks are used to perform storage provider actions which cannot be performed in a generic manner across multiple providers. |
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 |
---|
| <list>
<string>task1</string>
<string>task2</string>
</list>
|
- "Content $contentID updated successfully"
Delete Content- Purpose: Removes a piece of content from the store
- Request:
DELETE - Purpose: Performs a particular task. Note that most tasks can be performed by only one storage provider type.
- Request:
POST https://host:port/durastore/taskspaceID/taskNamecontentID ? (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.
TaskstaskName | Storage Provider | Name | Description | Request Body | Response Body |
---|
enable-streaming | Amazon S3 | 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 | Amazon S3 | 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 | Amazon S3 | 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 | Amazon S3 | Test task | Provides a simple way to test the calling of tasks | Body content is ignored | Text indicating successful task completion | restore-content | Amazon Glacier | 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.) |
|
DuraService
Purpose: DuraService is the application through which DuraCloud manages services. The DuraService REST API provides the means by which services available in the DuraCloud service repository are deployed, configured, and undeployed.
Resources: XML schema which define the service configuration can be found on the Downloads page
- Response Code: 200 (on success)
- Response Body: "Content $contentID deleted successfully"
|
Panel |
---|
title | Audit Log REST Methods |
---|
|
Get Audit Log |
Panel |
---|
title | Manifest REST Methods |
---|
|
Get Manifest- Purpose: Returns the manifest for a given space and storeId
- Request:
GET https://host:port/durastore/manifest/{spaceId} ? (storeID) (format) spaceID - ID of the space for which the manifest will be retrieved storeID (optional) - ID of the content storage provider to query (default is primary store) format (optional) - TSV or BAGIT (default is TSV)
Response Code: 200 (on success), 404 if manifest was not found. Response Body: TSV in chronological order with the following fields. Code Block |
---|
| space-id content-id MD5
auditlogs localhost/51/auditlogs/localhost_51_auditlogs-2014-09-10-15-56-07.tsv 6992f8e57dafb17335f766aa2acf5942
auditlogs localhost/51/photos/localhost_51_photos-2014-09-10-15-55-01.tsv 820e786633fb495db447dc5d5cf0b2bd |
Generate Manifest- Purpose: Asynchronously generates a gzipped manifest for a given space and storeId. This approach may be preferable if you wish to obtain a manifest for a larger space. We recommend considering this option for spaces that are larger than 100K items.
- Request:
POST https://host:port/durastore/manifest/{spaceId} ? (storeID) (format) spaceID - ID of the space for which the manifest will be generated storeID (optional) - ID of the content storage provider to query (default is primary store) format (optional) - TSV or BAGIT (default is TSV)
Response Code: 202 (on success), 404 if manifest was not found. Response Body: We are processing your manifest generation request. To retrieve your file, please poll the URI in the Location header of this response Response Headers: Code Block |
---|
| Location: <URI-of-generated-manifest> |
|
Panel |
---|
title | Storage Report REST Methods |
---|
|
Get Storage Reports by SpaceGet Storage Reports by Store- Purpose: Returns storage report summaries for all content in a storage provider. Report values are averaged based on the grouping internal (if groupBy=month, all data points within each month are averaged to provide an aggregate result).
|
Panel |
---|
title | Initialization REST Methods |
---|
|
Initialize ServicesPurpose: Initializes the DuraService applicationRequest: POST https://host:port/duraservice/init Request Body: XML similar to: Code Block |
---|
| xml | xml |
<servicesConfig>
<primaryServiceInstance>
<host>[PRIMARY-SERVICE-INSTANCE-HOST]</host>
<servicesAdminPort>[PRIMARY-SERVICES-ADMIN-PORT]</servicesAdminPort>
<servicesAdminContext>[PRIMARY-SERVICES-ADMIN-CONTEXT]</servicesAdminContext>
</primaryServiceInstance>
<userStorage>
<host>[USER-STORAGE-HOST-NAME]</host>
<port>[USER-STORAGE-PORT]</port>
<context>[USER-STORAGE-CONTEXT]</context>
<msgBrokerUrl>[USER-STORAGE-MSG-BROKER-URL]</msgBrokerUrl>
</userStorage>
<serviceStorage>
<host>[SERVICES-STORAGE-HOST-NAME]</host>
<port>[SERVICES-STORAGE-PORT]</port>
<context>[SERVICES-STORAGE-CONTEXT]</context>
<spaceId>[SERVICES-STORAGE-SPACE-ID]</spaceId>
</serviceStorage>
<serviceCompute>
<type>AMAZON_EC2</type>
<imageId>[MACHINE-IMAGE-ID]</imageId>
<computeProviderCredential>
<username>[USERNAME]</username>
<password>[PASSWORD]</password>
</computeProviderCredential>
</serviceCompute>
</servicesConfig>
|
Response Code: 200 (on success)Response Body: "Initialization Successful" (on success)Is Initialized
- Purpose: Performs a check to determine if the DuraService application has been initialized
- Request:
GET https://host:port/duraservice/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.
Panel |
---|
title | Service REST Methods |
---|
|
durastore/report/store ? (storeID) (start) (end) (groupBy) storeID (optional) - ID of the content storage provider to query (default is primary store) start (optional) - Timestamp in epoch milliseconds which defines the starting point for results. Any data points which are prior to this value are not included. end (optional) - Timestamp in epoch milliseconds which defines the end point for results. Any data points which are after this value are not included. usage note: To ensure that all expected data points are included, set the end timestamp to the very end of the final interval (e.g. 23:59:59 on the last day of the week/month)
groupBy (optional) - Grouping interval which allows for averaged results for days, weeks, and months. Valid values are: "day", "week", and "month" (default is day)
Get Services- Purpose: Retrieves a listing of services, along with their configuration options
- Request:
GET https://host:port/duraservice/services ? (show)
- Parameter options for show (optional)
- available (default) - Includes only services which have not been deployed but are available for deployment
- deployed - Includes only services which have been deployed and started
- Response Code: 200 (on success)
- Response Body: XML list of services (see service config xsd)
Get ServiceGet Deployed Service- Purpose: Retrieves information about a deployed service including description, configuration options, and a single deployment indicating the configuration options in use
- Request:
GET https://host:port/duraservice/serviceID/deploymentID - Response Code: 200 (on success)
- Response Body: XML service (see service config xsd)
Get Deployed Service Properties- Purpose: Retrieves the runtime properties of a deployed service
- Request:
GET https://host:port/duraservice/serviceID/deploymentID/properties - Response Code: 200 (on success)
- Response Body: XML service (simple xml Map serialization)
Deploy ServiceGet Storage Reports for all Spaces in a Store (in a single day)- Purpose: Returns storage report summaries for all spaces in a storage provider on a single day.
- Request:
GET - Purpose: Deploys and starts an available service
- Request:
PUT https://host:port/durastore/report/duraservicestore/serviceID {date} ? (serviceHost)
storeID) date - Timestamp in epoch milliseconds which specifies the requested day storeID Parameter value for serviceHost (optional) should indicate the services host on which the service should be deployed. Default is the primary customer host.
- Request Body: XML user configuration indicating the config selections for the service (see user config portion of service config xsd)
- Response Code: 201 (on success)
- Response Header: Location header indicates the URL at which information about the deployed service can be retrieved (the URL for a get deployed service call) which includes the deploymentID
Update Service Configuration- Purpose: Updates the configuration of a deployed service
- Request:
POST https://host:port/duraservice/serviceID/deploymentID - Request Body: Updated XML user configuration indicating the config selections for the service (see user config portion of service config xsd)
- Response Code: 200 (on success)
UnDeploy Service- Purpose: Stops and Undeploys a deployed service
- Request:
DELETE https://host:port/duraservice/serviceID/deploymentID - Response Code: 200 (on success)
|
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.
Panel |
---|
title | Bit Integrity REST Methods |
---|
|
Get Bit Integrity Report- Purpose: Retrieves the latest bit integrity report for a given space and store
- Request:
GET
|
Panel |
---|
title | Initialization REST Methods |
---|
|
Initialize ApplicationIs 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 and services managed by DuraCloud. DuraBoss consists of four major applications:
- Reporter - generates reports relating to the status of the storage and services within DuraCloud
- Executor - manages actions which automate functions within DuraCloud, primarily the scheduling and running of DuraCloud services
- Auditor - maintains audit logs for all spaces within DuraCloud, ensuring that all additions, update, and deletions are recorded and made available
- Manifest - provides manifests in various formats for the content that resides in DuraCloud spaces
Resources: XML schema which defines the expected transfer data for storage and service reporting can be found on the Downloads page
, 404 if space doesn't exist, 204 if no report is available for that space. - Response Headers:
- Bit-Integrity-Report-Completion-Date: yyyy-MM-ddTHH:mm:ss
- Bit-Integrity-Report-Result: (SUCCESS or FAILURE)
Response Body: TSV with the following fields. Code Block |
---|
| date-checked account store-id store-type space-id content-id result content-checksum provider-checksum manifest-checksum details |
Get Bit Integrity Report Properties- Purpose: Retrieves details about the latest bit integrity report for a given space and store, but not the report itself
- Request:
HEAD
|
Panel |
---|
title | Initialization REST Methods |
---|
|
Initialize Application- Purpose: Allows the initialization of duraboss
- Request:
POST https://host:port/durastore/duraboss/init Request Body: XML similar to: Code Block |
---|
xml | xml | <durabossConfig>
<reporterEnabled>[true|false]</reporterEnabled>
<executorEnabled>[true|false]</executorEnabled>
<auditorEnabled>[true|false]</auditorEnabled>
<durastoreHost>[host]</durastoreHost>
<durastorePort>[port]</durastorePort>
<durastoreContext>durastore</durastoreContext>
<duraserviceHost>[host]</duraserviceHost>
<duraservicePort>[port]</duraservicePort>
<duraserviceContext>duraservice</duraserviceContext>
<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>
bit-integrity/{spaceId} ? (storeID) Optional parameter 'storeID': if not set, primary storage provider is used.
Response Code: 200 (on success), 404 if space doesn't exist, 204 if no report is available for that space. - Response Headers: same as for Get Bit Integrity Report (above)
|
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: "Initialization Successful" (on success)
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.
|
Panel |
---|
title | Reporter: Storage Report REST Methods |
---|
|
Get Latest Storage Report- Purpose: Provides the most current storage report in XML format
- Request:
GET https://host:port/duraboss/report/storage - Response Code: 200 (on success)
- Response Body: XML, defined by the storage report XSD
Get Storage Report List- Purpose: Provides a list of all storage report IDs
- Request:
GET https://host:port/duraboss/report/storage/list - Response Code: 200 (on success)
- Response Body: XML, defined by the storage report XSD
Get Storage Report- Purpose: Provides a specific storage report based on the provided report ID
- Request:
GET https://host:port/duraboss/report/storage/reportID - Response Code: 200 (on success)
- Response Body: XML, defined by the storage report XSD
Get Storage Report Info- Purpose: Provides a information about the current status of the storage reporting system
- Request:
GET https://host:port/duraboss/report/storage/info - Response Code: 200 (on success)
- Response Body: XML, defined by the storage report XSD
Start Storage Report- Purpose: Starts a storage report if one is not already running
- Request:
POST https://host:port/duraboss/report/storage - Response Code: 200 (on success)
- Response Body: "Report Started" (on success), or ""Report Already In Progress" (if a report is already in progress)
Cancel Storage Report- Purpose: Cancels a running storage report
- Request:
DELETE https://host:port/duraboss/report/storage - Response Code: 200 (on success)
- Response Body: "Storage report cancelled"
Schedule Storage Report- Purpose: Schedules a time for a storage report to be run
- Request:
POST https://host:port/duraboss/report/storage/schedule ? (startTime) (frequency)
- startTime: time (in milliseconds since the epoch) to begin the next storage report
- frequency: time (in milliseconds) to wait between running reports (minimum value is 600000)
- Response Code: 200 (on success)
- Response Body: "Storage reports scheduled" (on success)
Cancel Storage Report Schedule- Purpose: Cancels all entries on the storage report schedule
- Request:
DELETE https://host:port/duraboss/report/storage/schedule - Response Code: 200 (on success)
- Response Body: "Storage Reports schedule cancelled"
|
Panel |
---|
title | Reporter: Service Report REST Methods |
---|
|
Get Deployed Services Report- Purpose: Provides a listing of the services which are currently deployed
- Request:
GET https://host:port/duraboss/report/service/deployed - Response Code: 200 (on success)
- Response Body: XML, defined by the service report XSDs
Get Completed Services Report- Purpose: Provides a listing of the most recent completed services
- Request:
GET https://host:port/duraboss/report/service ? (limit)
- Parameter value for limit (optional) should indicate the maximum number of services to return in the report (default is 20, max is 1000)
- Response Code: 200 (on success)
- Response Body: XML, defined by the service report XSDs
Get Completed Services Report List- Purpose: Provides a listing of all service report IDs
- Request:
GET https://host:port/duraboss/report/service/list - Response Code: 200 (on success)
- Response Body: XML, defined by the service report XSDs
Get Services Report- Purpose: Provides a specific services report based on the provided report ID
- Request:
GET https://host:port/duraboss/report/service/reportID - Response Code: 200 (on success)
- Response Body: XML, defined by the service report XSDs
|
Panel |
---|
title | Executor REST Methods |
---|
|
Get Executor Status- Purpose: Provides a status of the Executor, which is the collected status of all Action Handlers
- Request:
GET https://host:port/duraboss/exec - Response Code: 200 (on success)
- Response Body: XML serialization of status map
Get Supported Executor Actions- Purpose: Provides a listing of the actions which the Executor can perform
- Request:
GET https://host:port/duraboss/exec/action - Response Code: 200 (on success)
- Response Body: XML serialization of the action set
Executor ActionsAction Name | Description | Request Body |
---|
start-bit-integrity | Instructs the bit integrity handler to begin the process at a given time and at a given frequency | start-time,frequency (where start-time is epoch date in milliseconds and frequency is number of milliseconds) | cancel-bit-integrity | Instructs the bit integrity handler to stop performing bit integrity checks and gracefully shut down | None | start-streaming | Starts the streaming service, so that media streaming can begin | None | stop-streaming | Shuts down the streaming service, stops streaming of all media | None | start-streaming-space | Begin streaming all content in the given space | Name of the space to stream | stop-streaming-space | Stop streaming content in the given space | Name of the space to end streaming |
- Purpose: Performs a specific Executor action based on the provided actionName
- Request:
POST https://host:port/duraboss/exec/actionName - Response Code: 200 (on success)
Shutdown Executor- Purpose: Requests that the Executor perform a graceful shutdown
- Request:
DELETE https://host:port/duraboss/exec - Response Code: 200 (on success)
|
Panel |
---|
title | Auditor REST Methods |
---|
|
Create Initial Audit Log- Purpose: Requests the creation of initial audit logs, and removal of any existing audit logs
- Request:
POST https://host:port/duraboss/audit - Response Code: 202 (on acceptance)
Get Audit Logs- Purpose: Provides a listing of the audit logs for the provided spaceId
- Request:
GET https://host:port/duraboss/audit/spaceId - Response Code: 200 (on success)
- Response Body: Plain text listing of audit log contentIds
Shutdown Auditor- Purpose: Requests that the Auditor perform a graceful shutdown
- Request:
DELETE https://host:port/duraboss/audit - Response Code: 200 (on success)
- Response Body: Plain text of "auditor shutting down"
|
- 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. When this call completes, two new properties will have been added to the set of properties for the specified space: - streaming-host - this is the RTMP host value, which can be used to generate URLs for open streams
- streaming-type - will either be OPEN or SECURE, depending on the value of the secure parameter provided when streaming was enabled
|
No Format |
---|
{
"spaceId" : "",
"secure" : ""
} |
spaceId - Name of the space for which streaming is to be enabled secure - true or false, should streaming be secured |
No Format |
---|
{
"result" : "",
"streamingHost" : ""
} |
result - Text indicating the results of the task streamingHost - the host name of the streaming endpoint | 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. |
No Format |
---|
{
"spaceId" : ""
} |
spaceId - Name of the space for which streaming is to be disabled |
No Format |
---|
{
"result" : ""
} |
result - 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. |
No Format |
---|
{
"spaceId" : ""
} |
spaceId - Name of the space for which streaming is to be deleted |
No Format |
---|
{
"result" : ""
} |
result - Text indicating the results of the task | get-url | Get URL task | Retrieves a URL for a media file that is streamed through Cloudfront via an open distribution |
No Format |
---|
{
"spaceId" : "",
"contentId" : "",
"resourcePrefix" : ""
} |
spaceId - Name of the space in which the streamed content is stored contentId - Name of the content item to be streamed resourcePrefix - A prefix on the content item which may be required by the streaming viewer. (e.g. an mp4 file may need a prefix of "mp4:") (optional) |
No Format |
---|
{
"streamUrl" : ""
} |
streamUrl - The URL to be used for streaming the requested content | get-signed-url | Get Signed URL task | Retrieves a signed URL for a media file that is streamed through Cloudfront via a secure distribution |
No Format |
---|
{
"spaceId" : "",
"contentId" : "",
"minutesToExpire" : "",
"ipAddress" : ""
"resourcePrefix" : ""
} |
spaceId - Name of the space in which the streamed content is stored contentId - Name of the content item to be streamed minutesToExpire - Number of minutes until the generated URL expires and the stream can no longer be played (optional, default is 480) ipAddress - IP address range where requests to stream must originate, in CIDR notation (e.g. 1.2.3.4/32) (optional) resourcePrefix - A prefix on the content item which may be required by the streaming viewer. (e.g. an mp4 file may need a prefix of "mp4:") (optional) |
No Format |
---|
{
"signedUrl" : ""
} |
signedUrl - The URL to be used for streaming the requested content | set-storage-policy | Set Storage Policy | Sets the S3 bucket lifecycle policies associated with a given space. This task is restricted to DuraCloud service administrators. |
No Format |
---|
{
"spaceId" : "",
"storageClass" : "",
"daysToTransition" : 0
} |
spaceId - Name of the space for which the storage policy should be set storageClass - One of "STANDARD_IA", "REDUCED_REDUNDANCY", or "GLACIER" daysToTransition - Number of days content should remain at standard storage before being transitioned to the new storage class |
No Format |
---|
{
"result" : ""
} |
result - Text indicating the results of the task | noop | Test task | Provides a simple way to test the calling of tasks | None | "Success" |
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" : ""
"alternateIds" :
["" , ""]
} |
| 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" : ""
} |
| complete-cancel-snapshot | Complete the cancellation of a snapshot | Handles the removal of any space properties, .collection-snapshot.properties file, and snapshot related user permissions. It should be called by the bridge after it has finished its cancellation process. |
No Format |
---|
{
"spaceId" : ""
} |
|
No Format |
---|
{
"result" : "text description of result"
} |
| restart-snapshot | Restart Snapshot task | Restarts the snapshot process if a failure occurred while transferring from DuraCloud to the bridge. |
No Format |
---|
{
"snapshotId" : ""
} |
|
No Format |
---|
{
"snapshotId" : "",
"status" : ""
} |
| 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" :
{
"" : ""
}
}]
} |
| get-snapshot-history | Get Snapshot History task | Retrieves a listing of events which have occurred in the history of a particular snapshot |
No Format |
---|
{
"snapshotId" : "",
"pageNumber" : 0,
"pageSize" : 0
} |
|
No Format |
---|
{
"totalCount" : 0,
"historyItems" :
[{
"history" : "",
"historyDate" : 0
}]
} |
| request-restore-snapshot | Request a snapshot restore | Sends a restore request to an duracloud admin level user. This call can be made by user with access to the snapshot in question. Action on the part of the admin receiving the request is required to initiate a restore. The value of the user email address parameter will be used for notification purposes once the restore begins. |
No Format |
---|
{
"snapshotId" : "",
"userEmail" : ""
} |
|
No Format |
---|
{
"description" : ""
} |
| restore-snapshot | Restore Snapshot task | Initiates the restoration of a snapshot to a DuraCloud space. This call requires admin access. |
No Format |
---|
{
"snapshotId" : "",
"userEmail" : ""
} |
|
No Format |
---|
{
"spaceId" : "",
"restoreId" : "",
"status" : ""
} |
| complete-restore | Complete Restore task | Completes the restoration action by setting up an expiration policy for restored content |
No Format |
---|
{
"spaceId" : "",
"daysToExpire" : 1
} |
|
No Format |
---|
{
"result" : ""
} |
| get-restore | Get Snapshot Restore task | Retrieves the status and details of a restore action. Note that you must specify either the snapshotId or the restoreId, but not both. Specifying the snapshotId will return the most recent restoration matching that snapshotId. Specifying the restoreId you will get back the restoration matching that ID (as you would expect). |
No Format |
---|
{
"snapshotId" : "",
"restoreId" : ""
} |
|
No Format |
---|
{
"restoreId" : "",
"snapshotId" : "",
"status" : "",
"startDate" : "",
"endDate" : "",
"statusText" : "",
"destinationHost" : "",
"destinationPort" : "",
"destinationStoreId" : "",
"destinationSpaceId" : ""
} |
|
|
Panel |
---|
title | Content Manifest REST Methods |
---|
|
Get Content ManifestPurpose: Requests the content manifest for the provided spaceId, in the requested format, as of the provided date, and for the provided storeIDRequest: GET https://host:port/duraboss/manifest/spaceId ? (format) (date) (storeID)
- Parameter options for format (optional)
- tsv (default) - Produces content manifest in tab-separated-value format
- bagit - Produces content manifest in BagIt format
- Parameter options for date (optional, current datetime is default)
- Any formatted date of the form: 'yyyy-MM-dd'T'HH:mm:ss.sss' or 'yyyy-MM' or any form in between these two
- Parameter options for storeID (optional, default is primary store)
Response Code: 200 (on success)Response Body: Plain text content manifest in the requested format
|