- Elastic Cloud Serverless
- Elasticsearch
- Elastic Observability
- Get started
- Observability overview
- Elastic Observability Serverless billing dimensions
- Create an Observability project
- Quickstart: Monitor hosts with Elastic Agent
- Quickstart: Monitor your Kubernetes cluster with Elastic Agent
- Quickstart: Monitor hosts with OpenTelemetry
- Quickstart: Unified Kubernetes Observability with Elastic Distributions of OpenTelemetry (EDOT)
- Quickstart: Collect data with AWS Firehose
- Get started with dashboards
- Applications and services
- Application performance monitoring (APM)
- Get started with traces and APM
- Learn about data types
- Collect application data
- View and analyze data
- Act on data
- Use APM securely
- Reduce storage
- Managed intake service event API
- Troubleshooting
- Synthetic monitoring
- Get started
- Scripting browser monitors
- Configure lightweight monitors
- Manage monitors
- Work with params and secrets
- Analyze monitor data
- Monitor resources on private networks
- Use the CLI
- Configure a Synthetics project
- Multifactor Authentication for browser monitors
- Configure Synthetics settings
- Grant users access to secured resources
- Manage data retention
- Scale and architect a deployment
- Synthetics Encryption and Security
- Troubleshooting
- Application performance monitoring (APM)
- Infrastructure and hosts
- Logs
- Inventory
- Incident management
- Data set quality
- Observability AI Assistant
- Machine learning
- Reference
- Get started
- Elastic Security
- Elastic Security overview
- Security billing dimensions
- Create a Security project
- Elastic Security requirements
- Elastic Security UI
- AI for Security
- Ingest data
- Configure endpoint protection with Elastic Defend
- Manage Elastic Defend
- Endpoints
- Policies
- Trusted applications
- Event filters
- Host isolation exceptions
- Blocklist
- Optimize Elastic Defend
- Event capture and Elastic Defend
- Endpoint protection rules
- Identify antivirus software on your hosts
- Allowlist Elastic Endpoint in third-party antivirus apps
- Elastic Endpoint self-protection features
- Elastic Endpoint command reference
- Endpoint response actions
- Cloud Security
- Explore your data
- Dashboards
- Detection engine overview
- Rules
- Alerts
- Advanced Entity Analytics
- Investigation tools
- Asset management
- Manage settings
- Troubleshooting
- Manage your project
- Changelog
Connect to your Elasticsearch Serverless endpoint
editConnect to your Elasticsearch Serverless endpoint
editThis page assumes you have already created an Elasticsearch Serverless project.
Learn how to securely connect to your Elasticsearch Serverless instance.
To connect to your Elasticsearch instance from your applications, client libraries, or tools like curl, you’ll need two key pieces of information: an API key and your endpoint URL. This guide shows you how to get these connection details and verify they work.
Create a new API key
editCreate an API key to authenticate your requests to the Elasticsearch APIs. You’ll need an API key for all API requests and client connections.
To create a new API key:
-
On the Getting Started page, scroll to Add an API Key and select New. You can also search for API keys in the global search field.
- In Create API Key, enter a name for your key and (optionally) set an expiration date.
- (Optional) Under Control Security privileges, you can set specific access permissions for this API key. By default, it has full access to all APIs.
- (Optional) The Add metadata section allows you to add custom key-value pairs to help identify and organize your API keys.
- Select Create API Key to finish.
After creation, you’ll see your API key displayed as an encoded string. Store this encoded API key securely. It is displayed only once and cannot be retrieved later. You will use this encoded API key when sending API requests.
You can’t recover or retrieve a lost API key. Instead, you must delete the key and create a new one.
Get your Elasticsearch endpoint URL
editThe endpoint URL is the address for your Elasticsearch instance. You’ll use this URL together with your API key to make requests to the Elasticsearch APIs. To find the endpoint URL:
- On the Getting Started page, scroll to Copy your connection details section, and find the Elasticsearch endpoint field.
- Copy the URL for the Elasticsearch endpoint.
Test connection
editUse curl to verify your connection to Elasticsearch.
curl will need access to your Elasticsearch endpoint and encoded API key.
Within your terminal, assign these values to the ES_URL and API_KEY environment variables.
For example:
export ES_URL="https://dda7de7f1d264286a8fc9741c7741690.es.us-east-1.aws.elastic.cloud:443" export API_KEY="ZFZRbF9Jb0JDMEoxaVhoR2pSa3Q6dExwdmJSaldRTHFXWEp4TFFlR19Hdw=="
Then run the following command to test your connection:
curl "${ES_URL}" \ -H "Authorization: ApiKey ${API_KEY}" \ -H "Content-Type: application/json"
You should receive a response similar to the following:
{ "name" : "serverless", "cluster_name" : "dda7de7f1d264286a8fc9741c7741690", "cluster_uuid" : "ws0IbTBUQfigmYAVMztkZQ", "version" : { ... }, "tagline" : "You Know, for Search" }
Now you’re ready to start adding data to your Elasticsearch Serverless project.