Skip to content

Clarify index settings & APIs that are not available in serverless #1728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Clarify index settings & APIs that are not available in serverless #1728

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da40420
Update differences-from-other-elasticsearch-offerings.md
kunisen Jun 13, 2025
f6b6fe4
Update differences-from-other-elasticsearch-offerings.md
kunisen Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions ...y-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,11 @@ These recommendations do not apply to indices using better binary quantization (

## Available {{es}} APIs [elasticsearch-differences-serverless-apis-availability]

Because {{serverless-full}} manages infrastructure automatically, certain Elasticsearch APIs are not available:
::::{important}
In {{serverless-full}}, configuration is limited to certain APIs, as Elastic automatically manages the infrastructure. As we are responsible for maintaining cluster stability, we make informed decisions about permissible actions to prevent unintended changes that could compromise service availability, performance, and data integrity, thereby ensuring the reliability of Serverless projects.
::::



Infrastructure operations
: * All `_nodes/*` operations
Expand Down Expand Up @@ -200,7 +204,9 @@ Refer to the [{{es-serverless}} API reference](https://www.elastic.co/docs/api/d

## Available {{es}} settings [elasticsearch-differences-serverless-settings-availability]

In {{serverless-full}} Elasticsearch projects, you can only configure [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md). Cluster-level settings and node-level settings are fully managed by Elastic.
::::{important}
In {{serverless-full}} Elasticsearch projects, configuration is limited to certain [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md), while Elastic fully manages cluster-level and node-level settings. As we are responsible for maintaining cluster stability, we make informed decisions about permissible actions to prevent unintended changes that could compromise service availability, performance, and data integrity, thereby ensuring the reliability of Serverless projects.
::::

Available settings
: **Index-level settings**: Settings that control how documents are processed, stored, and searched are available to end users. These include:
Expand All @@ -218,6 +224,24 @@ Managed settings
* Shard allocation
* Resource management

When attempting to use an unavailable index setting, you'll receive this error:

```json
{
"error": {
"root_cause": [
{
"type": "illegal_argument_exception",
"reason": "Settings [xyz] are not available when running in serverless mode"
}
],
"type": "illegal_argument_exception",
"reason": "Settings [xyz] are not available when running in serverless mode"
},
"status": 400
}
```

## Learn more

- [{{serverless-full}} roadmap](https://www.elastic.co/cloud/serverless/roadmap): See upcoming features and development plans for the Serverless platform
Expand Down
Loading