Update uptime settings

Base URL: https://{kibana_url}

PUT /api/uptime/settings

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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

Response

Indicates a successful call

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

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

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/uptime/settings" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -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": []
      }
  }'

Generated from the API spec

Response

A successful response from 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": []
    }
}

Request Console 1 / 2 languages

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

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/uptime/settings" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "heartbeatIndices": "heartbeat-8*",
}'

Generated from the API spec

Response

A successful response from 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": []
    }
}

Authentication

Request body { }

Response

Request body