kibana/docs/api/uptime/get-settings.asciidoc
2023-10-23 06:14:37 -07:00

39 lines
939 B
Text

[[get-settings-api]]
== Get settings API
++++
<titleabbrev>Get settings</titleabbrev>
++++
Retrieve uptime settings existing settings.
[[get-settings-api-request]]
=== {api-request-title}
`GET <kibana host>:<port>/api/uptime/settings`
`GET <kibana host>:<port>/s/<space_id>/api/uptime/settings`
=== {api-prereq-title}
You must have `read` privileges for the *uptime* feature in *{observability}* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.
The API returns the following:
[source,sh]
--------------------------------------------------
{
"heartbeatIndices": "heartbeat-8*",
"certExpirationThreshold": 30,
"certAgeThreshold": 730,
"defaultConnectors": [
"08990f40-09c5-11ee-97ae-912b222b13d4",
"db25f830-2318-11ee-9391-6b0c030836d6"
],
"defaultEmail": {
"to": [],
"cc": [],
"bcc": []
}
}
--------------------------------------------------