TM1 settings

You can use the Logger entity type and ServerSettings entity types to retrieve and update TM1 log file settings.

Retrieve, update, and delete tm1s-log.properties file settings

The Logger entity type and the entity set /api/v1/Loggers represent the tm1s-log.properties file. Each logger has a name, which corresponds with the logger name in the tm1s-log.properties file. For example, the logger named "TM1.API.Parameters" has the same name as a Logger entity. Each logger has a log level, which corresponds to the log levels that are set in the tm1s-log.properties file.

Loggers are all present in the entity set, even if they're not specified in tm1s-log.properties file. To set the level, use a PATCH request on the logger:

PATCH /api/v1/Loggers('TM1.API.Parameters')
{ "Level" : "Debug" }

You can use a DELETE request to remove a logger setting. The logger remains in the entity set. This is useful if you want the logger setting to revert to inheriting its level from a parent logger. For example, TM1.API is a parent of TM1.API.Parameters.

Retrieve and update tm1s.cfg file settings

The ServerSettings entity type represents the tm1s.cfg file settings. The following types cover the publicly documented tm1s.cfg file settings:

AccessSettings
  • NetworkSettings
  • AuthenticationSettings
  • SSLSettings
  • CAMSettings
  • LDAPSettings
  • CAPISettings
  • HTTPSettings
AdministrationSettings
  • ClientSettings
  • AuditLogSettings
  • DebugLogSettings
  • ServerLogSettings
  • EventLogSettings
  • JavaSettings
  • ExternalDatabaseSettings
  • TM1WebSettings
ModellingSettings
  • SpreadingSettings
  • TISettings
  • RulesSettings
  • StartupSettings
  • SynchronizationSettings
PerformanceSettings
  • MemorySettings
  • MTQSettings
  • LockingSettings
  • ViewCalculationSettings
  • StargateSettings
  • JobQueuingSettings

The EDM schema has two root level instances of the ServerSettings entity type, /api/v1/ActiveConfiguration and /api/v1/StaticConfiguration.

ActiveConfiguration is read-only, and represents the current state of the server, not necessarily what exists in the tm1s.cfg file. Many parameters are static and need a server restart for changes to take effect.

StaticConfiguration can be written with PATCH requests to modify the tm1s.cfg file. The PATCH request triggers a config refresh, and if the updated parameter is dynamic, ActiveConfiguration is updated to reflect the change. StaticConfiguration always reflects what is in the tm1s.cfg file.