Create an Elasticsearch project
Create an Elasticsearch project. The response will include the created project details, such as the project ID, the credentials to access the project, and the endpoints to access different apps such as Elasticsearch and Kibana. The credentials can be regenerated at any time using the _reset-credentials endpoint.
Body Required
Configuration of the elasticsearch project to create.
-
Descriptive name for a project.
Minimum length is
1
, maximum length is255
. -
alias string
A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
Minimum length is
1
, maximum length is50
. Format should match the following pattern:^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$
. -
Unique human-readable identifier for a region in Elastic Cloud.
-
optimized_for string
The purpose for which the hardware of this elasticsearch project is optimized for. Also known as the Elasticsearch project subtype.
Values are
general_purpose
orvector
. -
search_lake object
Configuration for entire set of capabilities that make the data searchable in Elasticsearch.
Additional properties are allowed.
curl \
-X POST https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch \
-H "Content-Type: application/json" \
-d '{"name":"Example project","region_id":"aws-us-east-1"}'
{
"name": "Example project",
"region_id": "aws-us-east-1"
}
# Headers
ETag: string
# Payload
{
"id": "string",
"name": "my project",
"alias": "my-project-alias",
"region_id": "aws-us-east-1",
"metadata": {
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "1014289666002276",
"organization_id": "198583657190",
"suspended_at": "2024-05-04T09:42:00+00:00",
"suspended_reason": "trial expired"
},
"cloud_id": "my_project:LmF3cy5lbGFzdG",
"type": "elasticsearch",
"optimized_for": "general_purpose",
"search_lake": {
"search_power": 100,
"boost_window": 100
},
"endpoints": {
"elasticsearch": "https://my-project-alias-df6c6d.es.us-east-1.aws.elastic.cloud",
"kibana": "https://my-project-alias-df6c6d.kb.us-east-1.aws.elastic.cloud"
},
"credentials": {
"username": "admin",
"password": "*****"
}
}
{
"errors": [
{
"message": "Explicative error message",
"code": "code.error"
}
]
}
{
"errors": [
{
"message": "Explicative error message",
"code": "code.error"
}
]
}