Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 DuraCloudExecutor - 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


Panel
titleInitialization REST Methods

Initialize Application

  • Purpose: Allows the initialization of duraboss
  • Request: POST https://host:port/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>
      <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>
    
  • 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.

...