Get uptime settings

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

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

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>

Response

Indicates a successful call

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/uptime/settings

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/uptime/settings" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

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