Skip to content

Create a new page for Serverless cloud id - #7825

Draft
yetanothertw wants to merge 3 commits into
mainfrom
cloud-id-serverless-345
Draft

Create a new page for Serverless cloud id#7825
yetanothertw wants to merge 3 commits into
mainfrom
cloud-id-serverless-345

Conversation

@yetanothertw

@yetanothertw yetanothertw commented Aug 6, 2026

Copy link
Copy Markdown
Member

Summary

Fixes #5150 and #345

The existing Find your Cloud ID page is ECH-only. Serverless projects also expose a Cloud ID (and an Elasticsearch endpoint / API keys), but the UI paths differ.

This PR:

The new page includes the following info:

  • covers the three connection concepts: Elasticsearch endpoint, API key, and Cloud ID (definition list + how-tos for finding the details).
  • API keys: high-level entry points only, with a link to the existing Serverless API keys page (no duplicated procedure).
  • Next steps point to Beats, Logstash, Elastic Agent, language clients, and the ingest overview (in the context of the purpose for which you'd want to connect your projects and tools/clients).

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Cursor's auto agent to find similar or contradictory information within the existing docset.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@florent-leborgne florent-leborgne left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, we can afford to not describe all of the methods I think. Just a few non-blocking adjustments to match the UI updates that landed today...

Just simply commenting to not block anything:)

**Cloud ID**
: A unique, encoded string that represents your project's {{es}} endpoint (and, where applicable, {{kib}} endpoint) in a compact form. Compatible clients can use it instead of configuring host URLs individually: the client resolves those endpoints from the Cloud ID.

## Find your {{es}} endpoint and Cloud ID [_find_elasticsearch_endpoint]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

FYI, this is changing as we speak in serverless, it just landed today

Image

It's still in the help menu though so this is still technically correct


## Create an API key [_create_api_key]

You can create an API key from your project's home page, or open the **API keys** page from the navigation menu or with the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
You can create an API key from your project's home page, or open the **API keys** page from the navigation menu or with the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
You can create an API key from your project's **API keys** page. You can access it from the navigation menu or with the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

I'd limit it to this method, since it's not true for all project types that it's on the home page (just looked in observability)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Or I noticed it's now also under connection details in another tab

Image

- id: cloud-serverless
---

# Find your project connection details [serverless-connection-details]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd put the full Serverless substitution in the title too


**Cloud ID**
: A unique, encoded string that represents your project's {{es}} endpoint (and, where applicable, {{kib}} endpoint) in a compact form. Compatible clients can use it instead of configuring host URLs individually: the client resolves those endpoints from the Cloud ID.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should we add something like a note for example that talks about the other endpoints available when managing the project from the cloud UI? Like the kibana endpoint & others, to disambiguate

@shainaraskas shainaraskas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

overall, this lgtm, but i worry about duplication with this page: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/7825/solutions/elasticsearch-solution-project/search-connection-details

wonder if anything nice can be taken from there, or if we should be snippetizing this so one or the other doesn't fall out of date

are there any places where this page should be cross-referenced? probably all links to find-cloud-id should be paired with a find-connection-details link if they apply to serverless.

side-quest:

one advantage of optimizing toward a single page for both ech + serverless is that these pages can share one link (and the old cloud id links can redirect to a surface that directly addresses both deployment types). another big thing is that the help link for cloud ID links to the ECH only page, which is not ideal

current placement is also more like one-time config rather than a place people would want to reference on an ongoing basis

Comment on lines +32 to +33

4. To copy the **Cloud ID**, enable **Show Cloud ID**, then copy the value.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

would prob sit the image below step 4

would also probably prefer the path florent pointed out because a help menu seems less friendly

Comment on lines +35 to +39
## Create an API key [_create_api_key]

You can create an API key from your project's home page, or open the **API keys** page from the navigation menu or with the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

For steps, privileges, and key types, refer to [Serverless project API keys](/deploy-manage/api-keys/serverless-project-api-keys.md).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

you can access serverless with two types of API keys: these, and cloud API keys. at minimum, we should have a pointer to cloud API keys here

cloud api keys let you manage the project at the "cloud" level, and also can be used anywhere the serverless project api key is used if the correct access is granted


# Find your project connection details [serverless-connection-details]

When you connect clients and tools to a {{serverless-full}} project, these are the main connection details you'll work with:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this page should link back to the cloud id page too - not sure which one will rank better

# Find your Cloud ID [ec-cloud-id]

::::{note}
This page is for {{ech}} deployments. If you're using a {{serverless-full}} project, refer to [Find your project connection details](find-connection-details-serverless.md).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
This page is for {{ech}} deployments. If you're using a {{serverless-full}} project, refer to [Find your project connection details](find-connection-details-serverless.md).
This page is for {{ech}} deployments. If you're using a {{serverless-full}} project, refer to [](find-connection-details-serverless.md).

Comment on lines +45 to +49
* [Beats for {{es-serverless}}](beats://reference/serverless/beats.md): Configure Beats to send logs, metrics, and other data using your {{es}} endpoint and API key.
* [Sending data to {{es-serverless}}](logstash://reference/connecting-to-serverless.md): Configure {{ls}} to send data to your project.
* [Install {{agent}}](/reference/fleet/install-elastic-agents.md): Collect and ship data with {{agent}} and Fleet.
* [{{es}} language clients](/reference/elasticsearch-clients/index.md): Connect applications to your project with an official client library.
* [Ingest: Bring your data to Elastic](/manage-data/ingest.md): Browse other ingest options, from APIs and connectors to OpenTelemetry.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
* [Beats for {{es-serverless}}](beats://reference/serverless/beats.md): Configure Beats to send logs, metrics, and other data using your {{es}} endpoint and API key.
* [Sending data to {{es-serverless}}](logstash://reference/connecting-to-serverless.md): Configure {{ls}} to send data to your project.
* [Install {{agent}}](/reference/fleet/install-elastic-agents.md): Collect and ship data with {{agent}} and Fleet.
* [{{es}} language clients](/reference/elasticsearch-clients/index.md): Connect applications to your project with an official client library.
* [Ingest: Bring your data to Elastic](/manage-data/ingest.md): Browse other ingest options, from APIs and connectors to OpenTelemetry.
* [Beats for {{es-serverless}}](beats://reference/serverless/beats.md): Configure Beats to send logs, metrics, and other data using your {{es}} endpoint and API key.
* [Sending data to {{es-serverless}}](logstash://reference/connecting-to-serverless.md): Configure {{ls}} to send data to your project.
* [](/reference/fleet/install-elastic-agents.md): Collect and ship data with {{agent}} and Fleet.
* [](/reference/elasticsearch-clients/index.md): Connect applications to your project with an official client library.
* [](/manage-data/ingest.md): Browse other ingest options, from APIs and connectors to OpenTelemetry.


You can create an API key from your project's home page, or open the **API keys** page from the navigation menu or with the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

For steps, privileges, and key types, refer to [Serverless project API keys](/deploy-manage/api-keys/serverless-project-api-keys.md).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

key types is kind of irrelevant in the context of creating your own key

also we can rely on autolink here

Suggested change
For steps, privileges, and key types, refer to [Serverless project API keys](/deploy-manage/api-keys/serverless-project-api-keys.md).
For steps, privileges, and key types, refer to [](/deploy-manage/api-keys/serverless-project-api-keys.md).

**Cloud ID**
: A unique, encoded string that represents your project's {{es}} endpoint (and, where applicable, {{kib}} endpoint) in a compact form. Compatible clients can use it instead of configuring host URLs individually: the client resolves those endpoints from the Cloud ID.

## Find your {{es}} endpoint and Cloud ID [_find_elasticsearch_endpoint]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we should also expose the cloud console pathway - this info is also available on the specific project's page under https://cloud.elastic.co/projects (click "manage", then look for connection alias for endpoints ... not sure if cloud id is available through this pathway)

@yetanothertw

Copy link
Copy Markdown
Member Author

Thanks both, it seems like this needs a bit more work, so I'll set it back into draft mode and address your feedback.

@yetanothertw
yetanothertw marked this pull request as draft August 12, 2026 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Equivalent of Cloud ID page but for Serverless

3 participants