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 5 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
5 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
0cd17dc
Update deploy-manage/deploy/elastic-cloud/differences-from-other-elas…
kunisen Jun 18, 2025
cbfb66a
Update deploy-manage/deploy/elastic-cloud/differences-from-other-elas…
kunisen Jun 18, 2025
abf2dc9
Merge branch 'main' into kunisen-docpr-sdhe-9039
kunisen Jun 18, 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
25 changes: 23 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 @@ -162,7 +162,10 @@ 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:
In {{serverless-full}}, access is limited to a subset of {{es}} APIs, as Elastic manages the underlying infrastructure. These restrictions help maintain cluster stability, availability, and data integrity, ensuring reliable operation of Serverless projects.

The following {{es}} APIs are not available in {{serverless-full}}:


Infrastructure operations
: * All `_nodes/*` operations
Expand Down Expand Up @@ -201,7 +204,7 @@ 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.
In {{serverless-full}} {{es}} projects, configuration available to users is limited to certain [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md), while Elastic manages cluster-level and node-level settings to maintain stability, availability, performance, and data integrity. These restrictions help ensure the reliability of Serverless projects.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this limited to elasticsearch projects? as far as I know, this applies to all project types because they all use elasticsearch as an underlying technology / you can always configure index settings

Copy link
Contributor Author

@kunisen kunisen Jun 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I don't think so. IIUC, it should be long to Elasticsearch itself but not Elasticsearch project. (ES used in other project type also should follow this)
I get your point and I think we can just remove Elasticsearch (or {{es}}).

cc @ppf2 for double check in case he has more insights.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 The ability to configure index settings and execute Elasticsearch APIs apply to all project types on Serverless, not just Elasticsearch (even though this tends to impact Elasticsearch project types more than other types).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding a suggestion to address this. Feel free to apply it when you are back from PTO @kunisen ;)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In {{serverless-full}} {{es}} projects, configuration available to users is limited to certain [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md), while Elastic manages cluster-level and node-level settings to maintain stability, availability, performance, and data integrity. These restrictions help ensure the reliability of Serverless projects.
In {{serverless-full}} projects, configuration available to users is limited to certain [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md), while Elastic manages cluster-level and node-level settings to maintain stability, availability, performance, and data integrity. These restrictions help ensure 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 @@ -219,6 +222,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