Update uptime settings

Server: https://{kibana_url}

PUT /api/uptime/settings
PUT /s/{space_id}/api/uptime/settings

Refer to Spaces for more information.

Update uptime setting attributes like heartbeatIndices, certExpirationThreshold, certAgeThreshold, defaultConnectors, or defaultEmail. You must have all privileges for the uptime feature in the Observability section of the Kibana feature privileges. A partial update is supported, provided settings keys will be merged with existing settings.

Request

Response

Indicates a successful call

application/json

Examples

Run PUT api/uptime/settings to update multiple Uptime settings.

Request Console 1 / 2 languages

Console Kibana Dev Tools

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": []
    }
}

curl Shell

curl -X PUT "https://{kibana_url}/api/uptime/settings" \
  -H "Content-Type: application/json" \
  -d '{
    "heartbeatIndices": "heartbeat-8*",
    "certExpirationThreshold": 30,
    "certAgeThreshold": 730,
    "defaultConnectors": [
        "08990f40-09c5-11ee-97ae-912b222b13d4",
        "db25f830-2318-11ee-9391-6b0c030836d6"
    ],
    "defaultEmail": {
        "to": [],
        "cc": [],
        "bcc": []
    }
}'

Response

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

Run PUT api/uptime/settings to update a single Uptime setting.

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X PUT "https://{kibana_url}/api/uptime/settings" \
  -H "Content-Type: application/json" \
  -d '{
    "heartbeatIndices": "heartbeat-8*",
}'

Response

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

Request { certAgeThreshold , certExpirationThreshold , defaultConnectors , defaultEmail , heartbeatIndices , }

Response

Request