DocumentationAEM 6.5User Guide

System information Service APIs system-information-service-apis

Last update: Fri May 24 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
  • Developer

The system information service provides a set of REST APIs to retrieve information. The following table provides detailed information about the APIs:

Name
URL
Descrption
SystemInfo.properties
https://'[server]:[port]'/rest/services/SystemInfo.properties'
This API is a wrapper for system.getProperties Java API. It retrieves configuration of the current working environment.
SystemInfo.envVar
https://'[server]:[port]'/rest/services/ SystemInfo.envVar
Retrieves all the environment variables of the host operating system.
SystemInfo.logs
https://'[server]:[port]'/rest/services/ SystemInfo.logs
Downloads a zip file that contains application server logs.
SystemInfo.config
https://'[server]:[port]'/rest/services/ SystemInfo.config
Retrieves all the content of the config.xml file.
SystemInfo.services
https://'[server]:[port]'/rest/services/ SystemInfo.services
Retrieves status and configuration parameters of AEM forms services.
SystemInfo.vitalDetails
https://'[server]:[port]'/rest/services/ SystemInfo.vitalDetails
Retrieves server uptime, JVM arguments, system memory, heap size, operating system name, number of active threads, and thread count.
SystemInfo.coreSettings
https://'[server]:[port]'/rest/services/ SystemInfo.coreSettings

Retrieves values of following properties:

  • AdobeTempDir

  • AdobeServerFontDir

  • CustomerFontDir

  • GlobalDocumentStorageRootDir

  • DefaultDocumentMaxInlineSize

  • DefaultDocumentDisposalTimeout

  • EnableDocumentDBStorage

  • GlobalDocumentStorageUseNetworkShare

  • EnableFIPS

  • EnableWSDL

  • DataServicesConfigFile

  • EnableRDS

SystemInfo.database
https://'[server]:[port]'/rest/services/ SystemInfo.database
Retrieves detailed information about the database.
SystemInfo.licenseInfo
https://'[server]:[port]'/rest/services/ SystemInfo.licenseInfo
Retrieves version and license information of installed AEM forms components.
SystemInfNo.serverConfig
https://'[server]:[port]'/rest/services/ SystemInfo.serverConfig
Downloads configuration files of the host application server.
SystemInfo.threads?delay=[n]&iterations=[n]
https://'[server]:[port]'/rest/services/ SystemInfo.threads?delay=[n]&iterations=[n]

Retrieves count and stack trace of active threads. It accepts following parameters:

  • iterations= [n]: Specifies the count of iterations. Replace n with a number.

  • Delay= [n]: Specifies the number of milliseconds to wait before starting the next iteration.

SystemInfo.info
https://'[server]:[port]'/rest/services/ SystemInfo.info

This API is a wrapper for all the system information service APIs. Internally, it runs all system information APIs and downloads information in zip format.

note: The SystemInfo.info does not provide count and stack trace of active threads.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2