Smile CDR v2024.08.PRE
On this page:
   36.10    Runtime Status Endpoint
  • JSON Admin Endpoints
  • 36.0 JSON Admin API
  • 36.1 Audit Log Endpoint
  • 36.2 Batch Job Endpoint
  • 36.3 Bulk Import Endpoint
  • 36.4 CDA Exchange Endpoint
  • 36.5 Metrics Endpoint
  • 36.6 Module Config Endpoint
  • 36.7 OpenID Connect Clients Endpoint
  • 36.8 OpenID Connect Servers Endpoint
  • 36.9 OpenID Connect Sessions Endpoint
  • 36.10 Runtime Status Endpoint
  • 36.11 System Config Endpoint
  • 36.12 Transaction Log Endpoint
  • 36.13 Troubleshooting Log Endpoint
  • 36.14 User Management Endpoint
    • 36.12    Transaction Log Endpoint   
       Table of Contents

    System Config Endpoint

    36.11.1System Config Endpoint

     

    The System Config endpoint can be used to access information about the system and configuration for debugging purposes.

    This method requires the VIEW_MODULE_CONFIG permission.

    This method will return a zip file containing:

    • Version and build information
    • Smile CDR configuration with sensitive information and scripts redacted
    • Node statuses
    • Processor count and memory information of the JVM
    • A thread dump

    To invoke:

    GET http://localhost:9000/system-config?includeLogs=true

    There is one optional boolean query parameter, called includeLogs. If set to true, this will cause all log files configured by smile cdr to be bundled up inside the zip. Note that this can take a long time if your logs are large.

    Note that logs can contain PHI depending on your setup. Always verify all logs to ensure they are stripped of PHI before sending them to Smile CDR for analysis.

    Note: added in 2021.05.R02.

       36.10    Runtime Status Endpoint
  • JSON Admin Endpoints
  • 36.0 JSON Admin API
  • 36.1 Audit Log Endpoint
  • 36.2 Batch Job Endpoint
  • 36.3 Bulk Import Endpoint
  • 36.4 CDA Exchange Endpoint
  • 36.5 Metrics Endpoint
  • 36.6 Module Config Endpoint
  • 36.7 OpenID Connect Clients Endpoint
  • 36.8 OpenID Connect Servers Endpoint
  • 36.9 OpenID Connect Sessions Endpoint
  • 36.10 Runtime Status Endpoint
  • 36.11 System Config Endpoint
  • 36.12 Transaction Log Endpoint
  • 36.13 Troubleshooting Log Endpoint
  • 36.14 User Management Endpoint
    • 36.12    Transaction Log Endpoint