Create an Elasticsearch project

POST /api/v1/serverless/projects/elasticsearch

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.

application/json

Body Required

A request to create an Elasticsearch serverless project.

name string Required

Descriptive name for a project.

Minimum length is 1, maximum length is 255.
alias string

A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.

Minimum length is 1, maximum length is 50. Format should match the following pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$.
region_id string Required

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 or vector.
search_lake object

Configuration for entire set of capabilities that make the data searchable in Elasticsearch.
Hide search_lake attributes Show search_lake attributes object
- search_power integer
  
  Controls how fast searches are against your project data. When ingested, a certain amount of data is loaded into a cache that makes it super fast to query. You can either increase the performance of searches on cached data by adding replicas, or reduce the quantity of cached data by a static factor to save on costs.
  
  Minimum value is 5, maximum value is 3000.
- boost_window integer
  
  Determines how much data can benefit from faster search. When ingested, a certain amount of data is loaded into a cache that makes it super fast to query. The system dynamically adjusts the cache allocated to your project based on how much data you ingest during the period defined by your Search Boost Window.
  
  Minimum value is 1, maximum value is 180.
Additional properties are NOT allowed

Responses

201 application/json

The created elasticsearch project.
Hide headers attribute Show headers attribute
- ETag string
Hide response attributes Show response attributes object
The created Elasticsearch project along with credentials to access Elasticsearch.
- id string Required
  
  ID of the project.
  
  Format should match the following pattern: ^[a-z0-9]{32}$.
- name string Required
  
  Descriptive name for a project.
  
  Minimum length is 1, maximum length is 255.
- alias string Required
  
  A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
  
  Minimum length is 1, maximum length is 50. Format should match the following pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$.
- region_id string Required
  
  Unique human-readable identifier for a region in Elastic Cloud.
- metadata object Required
  
  Additional details about the project.
  
  Hide metadata attributes Show metadata attributes object
  
  created_at string(date-time) Required
  
  Date and time when the project was created.
  
  created_by string Required
  
  ID of the user.
  
  organization_id string Required
  
  The Organization ID who owns the project.
  
  suspended_at string(date-time)
  
  Date and time when the project was suspended.
  
  suspended_reason string
  
  Reason why the project was suspended.
- cloud_id string Required
  
  The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
- type string Required
  
  the type of the project
  
  Value is elasticsearch.
- optimized_for string Required
  
  The purpose for which the hardware of this elasticsearch project is optimized for. Also known as the Elasticsearch project subtype.
  
  Values are general_purpose or vector.
- search_lake object
  
  Configuration for entire set of capabilities that make the data searchable in Elasticsearch.
  
  Hide search_lake attributes Show search_lake attributes object
  
  search_power integer
  
  Controls how fast searches are against your project data. When ingested, a certain amount of data is loaded into a cache that makes it super fast to query. You can either increase the performance of searches on cached data by adding replicas, or reduce the quantity of cached data by a static factor to save on costs.
  
  Minimum value is 5, maximum value is 3000.
  
  boost_window integer
  
  Determines how much data can benefit from faster search. When ingested, a certain amount of data is loaded into a cache that makes it super fast to query. The system dynamically adjusts the cache allocated to your project based on how much data you ingest during the period defined by your Search Boost Window.
  
  Minimum value is 1, maximum value is 180.
- endpoints object Required
  
  The endpoints to access the different apps of the project.
  
  Hide endpoints attributes Show endpoints attributes object
  
  elasticsearch string Required
  
  The endpoint to access elasticsearch.
  
  kibana string Required
  
  The endpoint to access kibana.
- credentials object Required
  
  Basic auth credentials to access the Elasticsearch API.
  
  Hide credentials attributes Show credentials attributes object
  
  username string Required
  
  Basic auth username that can be used to access the Elasticsearch API.
  
  password string Required
  
  Basic auth password that can be used to access the Elasticsearch API.
400 application/json

Bad request
Hide response attribute Show response attribute object
A non-empty list of errors.
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  An error response returned by the API.
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.
422 application/json

Unprocessable entity
Hide response attribute Show response attribute object
A non-empty list of errors.
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  An error response returned by the API.
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.

POST /api/v1/serverless/projects/elasticsearch

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"}'

Request example

{
  "name": "Example project",
  "region_id": "aws-us-east-1"
}

Response examples (201)

# 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": 7,
    "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": "*****"
  }
}

Response examples (400)

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}

Response examples (422)

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}