This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

› › ›

Update settings API

edit

Update settings API

edit

Updates uptime settings attributes like heartbeatIndices, certExpirationThreshold, certAgeThreshold, defaultConnectors or defaultEmail

Request

edit

PUT <kibana host>:<port>/api/uptime/settings

PUT <kibana host>:<port>/s/<space_id>/api/uptime/settings

Prerequisites

edit

You must have all privileges for the uptime feature in Observability section of the Kibana feature privileges.

Path parameters

edit

space_id: (Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Request body

edit

A partial update is supported, provided settings keys will be merged with existing settings.

heartbeatIndices: (Optional, string) index pattern string to be used within uptime app/alerts to query heartbeat data. Defaults to heartbeat-*.
certExpirationThreshold: (Optional, number) Number of days before a certificate expires to trigger an alert. Defaults to 30.
certAgeThreshold: (Optional, number) Number of days after a certificate is created to trigger an alert. Defaults to 730.
defaultConnectors: (Optional, array) List of connector IDs to be used as default connectors for new alerts. Defaults to [].
defaultEmail: (Optional, object) Default email configuration for new alerts. Defaults to {"to": [], "cc": [], "bcc": []}.

Example

edit

PUT api/uptime/settings
{
    "heartbeatIndices": "heartbeat-8*",
    "certExpirationThreshold": 30,
    "certAgeThreshold": 730,
    "defaultConnectors": [
        "08990f40-09c5-11ee-97ae-912b222b13d4",
        "db25f830-2318-11ee-9391-6b0c030836d6"
    ],
    "defaultEmail": {
        "to": [],
        "cc": [],
        "bcc": []
    }
}

The API returns the following:

{
    "heartbeatIndices": "heartbeat-8*",
    "certExpirationThreshold": 30,
    "certAgeThreshold": 730,
    "defaultConnectors": [
        "08990f40-09c5-11ee-97ae-912b222b13d4",
        "db25f830-2318-11ee-9391-6b0c030836d6"
    ],
    "defaultEmail": {
        "to": [],
        "cc": [],
        "bcc": []
    }
}

Partial update example

edit

PUT api/uptime/settings
{
    "heartbeatIndices": "heartbeat-8*",
}

The API returns the following:

{
    "heartbeatIndices": "heartbeat-8*",
    "certExpirationThreshold": 30,
    "certAgeThreshold": 730,
    "defaultConnectors": [
        "08990f40-09c5-11ee-97ae-912b222b13d4",
        "db25f830-2318-11ee-9391-6b0c030836d6"
    ],
    "defaultEmail": {
        "to": [],
        "cc": [],
        "bcc": []
    }
}

« Get settings API Kibana plugins »