(408) 943-4100               V   Commercial Support

alertplugins/current_settings

  1 minute read.

Last Modified 2021-02-04 11:38 EST
NamespaceNameAdmin OnlyLog SummaryGenerates EventVersion Added
alertpluginscurrent_settingsnonono1.1

Description

Return all the current settings for alert plugins for the current user. Any plugin settings with sensitive information (such as passwords or authentication tokens) will return “—-” as the value for that sensitive information when the option is currently defined in the settings.

Input Arguments

  • Required:
    • none ({})
  • Optional:
    • “plugins” : (string or Json Array of strings) Only return the settings for these plugins.

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{
  "plugins" : "smtp-email"
}

Reply Example

{
  "smtp-email" : {
    "mailserver" : "smtp.gmail.com",
    "mailserver_port" : 587,
    "auth_type" : "plain",
    "auth_user" : "example@example.net",
    "auth_pass" : "----",
    "from" : "no-reply@truecommand.io",
    "to" : ["example@example.net"],
    "subject" : "TrueCommand Alert Notice",
    "cc" : null,
    "bcc" : null
  }
}

Events

This API call does not emit any middleware events.

Log Summary

This API call does not generate a detailed log summary item

See Also