Get Notification Config

Get Notification Config

Get the values making the configuration of notifications.

Request
URI
GET
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/configuration/notification
COPY
Responses
200

Details of the notification configuration.

Returns NotificationConfig of type(s) */*
{
    "enabled": false,
    "enabledNotifications": [
        "string"
    ],
    "passwordExpirationThreshold": 0,
    "certificateExpirationThreshold": 0,
    "schedulerCronExpression": "string",
    "emailNotification": {
        "enabled": false,
        "smtpServer": "string",
        "smtpPort": 0,
        "smtpUsername": "string",
        "smtpPassword": "string",
        "useTls": false,
        "useSsl": false,
        "useProxy": false,
        "senderAddress": "string",
        "emailSubjectTemplate": "string",
        "emailContentTemplate": "string",
        "receiverAddresses": [
            "string"
        ]
    }
}
boolean
enabled
Optional

Enable or disable notifications.

array of string
enabledNotifications
Optional

List of enabled notification types. Possible values: TASK_COMPLETION, PASSWORD_EXPIRATION, PASSWORD_EXPIRATION_WARNING, CERTIFICATE_EXPIRATION, CERTIFICATE_EXPIRATION_WARNING

Possible values are : task completion, password expiration, password expiration warning, certificate expiration, certificate expiration warning,
integer As int32 As int32
passwordExpirationThreshold
Optional

Days before expiration date of a password to send a warning notification.

integer As int32 As int32
certificateExpirationThreshold
Optional

Days before expiration date of a certificate to send a warning notification.

string
schedulerCronExpression
Optional

A spring cron expression to define how frequent to check for expired passwords or certificates. Default: every day at midnight - expression: 0 0 0 * * *

emailNotification
Optional

The mail configuration to be tested.


401

Unauthorized access

Returns NotificationConfig of type(s) */*
{
    "enabled": false,
    "enabledNotifications": [
        "string"
    ],
    "passwordExpirationThreshold": 0,
    "certificateExpirationThreshold": 0,
    "schedulerCronExpression": "string",
    "emailNotification": {
        "enabled": false,
        "smtpServer": "string",
        "smtpPort": 0,
        "smtpUsername": "string",
        "smtpPassword": "string",
        "useTls": false,
        "useSsl": false,
        "useProxy": false,
        "senderAddress": "string",
        "emailSubjectTemplate": "string",
        "emailContentTemplate": "string",
        "receiverAddresses": [
            "string"
        ]
    }
}
boolean
enabled
Optional

Enable or disable notifications.

array of string
enabledNotifications
Optional

List of enabled notification types. Possible values: TASK_COMPLETION, PASSWORD_EXPIRATION, PASSWORD_EXPIRATION_WARNING, CERTIFICATE_EXPIRATION, CERTIFICATE_EXPIRATION_WARNING

Possible values are : task completion, password expiration, password expiration warning, certificate expiration, certificate expiration warning,
integer As int32 As int32
passwordExpirationThreshold
Optional

Days before expiration date of a password to send a warning notification.

integer As int32 As int32
certificateExpirationThreshold
Optional

Days before expiration date of a certificate to send a warning notification.

string
schedulerCronExpression
Optional

A spring cron expression to define how frequent to check for expired passwords or certificates. Default: every day at midnight - expression: 0 0 0 * * *

emailNotification
Optional

The mail configuration to be tested.


404

Such resource was not found.

Returns NotificationConfig of type(s) */*
{
    "enabled": false,
    "enabledNotifications": [
        "string"
    ],
    "passwordExpirationThreshold": 0,
    "certificateExpirationThreshold": 0,
    "schedulerCronExpression": "string",
    "emailNotification": {
        "enabled": false,
        "smtpServer": "string",
        "smtpPort": 0,
        "smtpUsername": "string",
        "smtpPassword": "string",
        "useTls": false,
        "useSsl": false,
        "useProxy": false,
        "senderAddress": "string",
        "emailSubjectTemplate": "string",
        "emailContentTemplate": "string",
        "receiverAddresses": [
            "string"
        ]
    }
}
boolean
enabled
Optional

Enable or disable notifications.

array of string
enabledNotifications
Optional

List of enabled notification types. Possible values: TASK_COMPLETION, PASSWORD_EXPIRATION, PASSWORD_EXPIRATION_WARNING, CERTIFICATE_EXPIRATION, CERTIFICATE_EXPIRATION_WARNING

Possible values are : task completion, password expiration, password expiration warning, certificate expiration, certificate expiration warning,
integer As int32 As int32
passwordExpirationThreshold
Optional

Days before expiration date of a password to send a warning notification.

integer As int32 As int32
certificateExpirationThreshold
Optional

Days before expiration date of a certificate to send a warning notification.

string
schedulerCronExpression
Optional

A spring cron expression to define how frequent to check for expired passwords or certificates. Default: every day at midnight - expression: 0 0 0 * * *

emailNotification
Optional

The mail configuration to be tested.


504

Connection timed out.

Returns NotificationConfig of type(s) */*
{
    "enabled": false,
    "enabledNotifications": [
        "string"
    ],
    "passwordExpirationThreshold": 0,
    "certificateExpirationThreshold": 0,
    "schedulerCronExpression": "string",
    "emailNotification": {
        "enabled": false,
        "smtpServer": "string",
        "smtpPort": 0,
        "smtpUsername": "string",
        "smtpPassword": "string",
        "useTls": false,
        "useSsl": false,
        "useProxy": false,
        "senderAddress": "string",
        "emailSubjectTemplate": "string",
        "emailContentTemplate": "string",
        "receiverAddresses": [
            "string"
        ]
    }
}
boolean
enabled
Optional

Enable or disable notifications.

array of string
enabledNotifications
Optional

List of enabled notification types. Possible values: TASK_COMPLETION, PASSWORD_EXPIRATION, PASSWORD_EXPIRATION_WARNING, CERTIFICATE_EXPIRATION, CERTIFICATE_EXPIRATION_WARNING

Possible values are : task completion, password expiration, password expiration warning, certificate expiration, certificate expiration warning,
integer As int32 As int32
passwordExpirationThreshold
Optional

Days before expiration date of a password to send a warning notification.

integer As int32 As int32
certificateExpirationThreshold
Optional

Days before expiration date of a certificate to send a warning notification.

string
schedulerCronExpression
Optional

A spring cron expression to define how frequent to check for expired passwords or certificates. Default: every day at midnight - expression: 0 0 0 * * *

emailNotification
Optional

The mail configuration to be tested.