diff --git a/docs/development/core/server/kibana-plugin-server.deprecationsettings.doclinkskey.md b/docs/development/core/server/kibana-plugin-server.deprecationsettings.doclinkskey.md
new file mode 100644
index 0000000000000..dc770d0f45d5d
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.deprecationsettings.doclinkskey.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) > [docLinksKey](./kibana-plugin-server.deprecationsettings.doclinkskey.md)
+
+## DeprecationSettings.docLinksKey property
+
+Signature:
+
+```typescript
+docLinksKey: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.deprecationsettings.md b/docs/development/core/server/kibana-plugin-server.deprecationsettings.md
new file mode 100644
index 0000000000000..3704609c4f431
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.deprecationsettings.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md)
+
+## DeprecationSettings interface
+
+UiSettings deprecation field options.
+
+Signature:
+
+```typescript
+export interface DeprecationSettings
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [docLinksKey](./kibana-plugin-server.deprecationsettings.doclinkskey.md) | string
| |
+| [message](./kibana-plugin-server.deprecationsettings.message.md) | string
| |
+
diff --git a/docs/development/core/server/kibana-plugin-server.deprecationsettings.message.md b/docs/development/core/server/kibana-plugin-server.deprecationsettings.message.md
new file mode 100644
index 0000000000000..a27e1121b4502
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.deprecationsettings.message.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) > [message](./kibana-plugin-server.deprecationsettings.message.md)
+
+## DeprecationSettings.message property
+
+Signature:
+
+```typescript
+message: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.md b/docs/development/core/server/kibana-plugin-server.md
index 5e28643843af3..b3c7218f0a43b 100644
--- a/docs/development/core/server/kibana-plugin-server.md
+++ b/docs/development/core/server/kibana-plugin-server.md
@@ -56,6 +56,7 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [DeprecationAPIClientParams](./kibana-plugin-server.deprecationapiclientparams.md) | |
| [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md) | |
| [DeprecationInfo](./kibana-plugin-server.deprecationinfo.md) | |
+| [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) | UiSettings deprecation field options. |
| [DiscoveredPlugin](./kibana-plugin-server.discoveredplugin.md) | Small container object used to expose information about discovered plugins that may or may not have been started. |
| [ElasticsearchError](./kibana-plugin-server.elasticsearcherror.md) | |
| [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) | |
diff --git a/docs/development/core/server/kibana-plugin-server.uisettingsparams.deprecation.md b/docs/development/core/server/kibana-plugin-server.uisettingsparams.deprecation.md
new file mode 100644
index 0000000000000..7ad26b85bf81c
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.uisettingsparams.deprecation.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) > [deprecation](./kibana-plugin-server.uisettingsparams.deprecation.md)
+
+## UiSettingsParams.deprecation property
+
+optional deprecation information. Used to generate a deprecation warning.
+
+Signature:
+
+```typescript
+deprecation?: DeprecationSettings;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.uisettingsparams.md b/docs/development/core/server/kibana-plugin-server.uisettingsparams.md
index a38499e8f37dd..94465530ab6c8 100644
--- a/docs/development/core/server/kibana-plugin-server.uisettingsparams.md
+++ b/docs/development/core/server/kibana-plugin-server.uisettingsparams.md
@@ -17,6 +17,7 @@ export interface UiSettingsParams
| Property | Type | Description |
| --- | --- | --- |
| [category](./kibana-plugin-server.uisettingsparams.category.md) | string[]
| used to group the configured setting in the UI |
+| [deprecation](./kibana-plugin-server.uisettingsparams.deprecation.md) | DeprecationSettings
| optional deprecation information. Used to generate a deprecation warning. |
| [description](./kibana-plugin-server.uisettingsparams.description.md) | string
| description provided to a user in UI |
| [name](./kibana-plugin-server.uisettingsparams.name.md) | string
| title in the UI |
| [optionLabels](./kibana-plugin-server.uisettingsparams.optionlabels.md) | Record<string, string>
| text labels for 'select' type UI element |
diff --git a/src/core/server/index.ts b/src/core/server/index.ts
index eccf3985fc495..b939a4da7c315 100644
--- a/src/core/server/index.ts
+++ b/src/core/server/index.ts
@@ -211,6 +211,7 @@ export {
export {
IUiSettingsClient,
+ DeprecationSettings,
UiSettingsParams,
UiSettingsType,
UiSettingsServiceSetup,
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
index bf7dc14c73265..ea9e8958b7529 100644
--- a/src/core/server/server.api.md
+++ b/src/core/server/server.api.md
@@ -635,6 +635,14 @@ export interface DeprecationInfo {
url: string;
}
+// @public
+export interface DeprecationSettings {
+ // (undocumented)
+ docLinksKey: string;
+ // (undocumented)
+ message: string;
+}
+
// @public
export interface DiscoveredPlugin {
readonly configPath: ConfigPath;
@@ -1928,6 +1936,7 @@ export type SharedGlobalConfig = RecursiveReadonly_2<{
// @public
export interface UiSettingsParams {
category?: string[];
+ deprecation?: DeprecationSettings;
description?: string;
name?: string;
optionLabels?: Record;
diff --git a/src/core/server/ui_settings/index.ts b/src/core/server/ui_settings/index.ts
index f1185474c2160..76258734b8a38 100644
--- a/src/core/server/ui_settings/index.ts
+++ b/src/core/server/ui_settings/index.ts
@@ -26,6 +26,7 @@ export {
UiSettingsServiceSetup,
UiSettingsServiceStart,
IUiSettingsClient,
+ DeprecationSettings,
UiSettingsParams,
InternalUiSettingsServiceSetup,
InternalUiSettingsServiceStart,