Workspace Settings Metadata

View as Markdown

ListGET /api/2.1/settings-metadata

SettingsMetadata object

namestringPublic Preview

Name of the setting.

descriptionstringPublic Preview

Setting description for what this setting controls

typestringPublic Preview

Sample message depicting the type of the setting. To set this setting, the value sent must match this type.

docs_linkstringPublic Preview

Link to databricks documentation for the setting

preview_phasestringBeta

Preview phase for feature preview settings. This field is not set for non-preview settings.

Values: PREVIEW_PHASE_UNSPECIFIED, PRIVATE_PREVIEW, PUBLIC_PREVIEW, BETA, GA_SOON, GA

display_namestringBeta

Human-readable display name for the setting or feature preview. This field may be unset if no display name is available.

View as Markdown

The SettingsMetadata object

{
  "name": "string",
  "description": "string",
  "type": "string",
  "docs_link": "string",
  "preview_phase": "string",
  "display_name": "string"
}

List Public Preview

GET /api/2.1/settings-metadata

List valid setting keys and metadata. These settings are available to be referenced via GET settingsv2/getpublicworkspacesetting and PATCH settingsv2/patchpublicworkspacesetting APIs

API scopes: settings

Parameters

page_sizeint32query

The maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 200 settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringquery

A page token, received from a previous ListWorkspaceSettingsMetadataRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkspaceSettingsMetadataRequest must match the call that provided the page token.

Response

Returns a list of SettingsMetadata objects.

View as Markdown

Response

{
  "settings_metadata": [
    {
      "name": "string",
      "description": "string",
      "type": "string",
      "docs_link": "string",
      "preview_phase": "string",
      "display_name": "string"
    }
  ],
  "next_page_token": "string"
}