Create an Elasticsearch project
https://api.elastic-cloud.com
- 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.
Query Parameters
-
exclude_credentialsboolean If true, the username and password fields in the response credentials are set to empty strings and no usable credentials are returned. Credentials can be retrieved later using the _reset-credentials endpoint.
Request
Configuration of the elasticsearch project to create.
-
namestring · min: 1 · max: 255required -
Descriptive name for a project.
-
aliasstring · min: 1 · max: 50 · pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$ -
A custom domain label compatible with RFC-1035 standards. Derived from the project name by default.
-
region_idstringrequired -
Unique human-readable identifier for a region in Elastic Cloud.
-
optimized_forElasticsearchOptimizedFor -
The purpose for which the hardware of this elasticsearch project is optimized. Also known as the Elasticsearch project subtype.
- The
general_purposeoption is suitable for most search use cases. For example, it is the right profile for full-text search, sparse vectors, and dense vectors that use compression such as BBQ. It is used by default when you create projects from the UI. - The
vectoroption is recommended only for uncompressed dense vectors (dense_vectorfields withint4orint8quantization strategies) and high dimensionality. Refer to documentation about billing dimensions for the impact to virtual compute unit (VCU) consumption.
- The
-
Values:
general_purposevector - Elasticsearch Serverless billing dimensions
-
search_lakeElasticsearchSearchLake -
Configuration for entire set of capabilities that make the data searchable in Elasticsearch.
-
search_powerinteger · min: 28 · max: 3000 -
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.
-
boost_windowinteger · min: 1 · max: 180 -
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.
-
min_search_vcuinteger · min: 2 · max: 2500 -
The minimum number of search VCUs allocated to your project.
-
linkedCreateLinkedRequest -
Configuration for linked projects associated with this project
-
metadataProjectMetadataRequest -
Metadata request for a project with tags.
-
Tags associated with a project in the form of key-value pairs. Tags are limited to a minimum of 1 and a maximum of 64 per project. Each tag key must begin with a lowercase letter (a-z), contain only lowercase letters, digits, underscores, and hyphens (a-z0-9_-), and have a maximum length of 32 characters.
Responses
The created elasticsearch project.
-
idstring · pattern: ^[a-z0-9]{32}$required -
ID of the project.
-
namestring · min: 1 · max: 255required -
Descriptive name for a project.
-
aliasstring · min: 8 · max: 57 · pattern: ^[a-zA-Z]{1}(?:[a-zA-Z0-9-]*[a-zA-Z0-9]{1})?$required -
A domain label compatible with RFC-1035 standards. Project alias with a unique suffix added by the system to avoid naming conflicts.
-
region_idstringrequired -
Unique human-readable identifier for a region in Elastic Cloud.
-
metadataProjectMetadatarequired -
Additional details about the project.
-
created_atstringrequired -
Date and time when the project was created.
-
created_bystringrequired -
ID of the user.
-
organization_idstringrequired -
The Organization ID who owns the project.
-
suspended_atstring -
Date and time when the project was suspended.
-
suspended_reasonstring -
Reason why the project was suspended.
-
Tags associated with a project in the form of key-value pairs. Tags are limited to a minimum of 1 and a maximum of 64 per project. Each tag key must begin with a lowercase letter (a-z), contain only lowercase letters, digits, underscores, and hyphens (a-z0-9_-), and have a maximum length of 32 characters.
-
System tags associated with a project in the form of key-value pairs. These tags are added by the internal system and are read-only. The keys are prefixed with an underscore to differentiate them from user tags.
-
cloud_idstringrequired -
The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana.
-
linkedLinkConfiguration -
Configuration for projects linked to this project
-
optimized_forElasticsearchOptimizedForrequired -
The purpose for which the hardware of this elasticsearch project is optimized. Also known as the Elasticsearch project subtype.
- The
general_purposeoption is suitable for most search use cases. For example, it is the right profile for full-text search, sparse vectors, and dense vectors that use compression such as BBQ. It is used by default when you create projects from the UI. - The
vectoroption is recommended only for uncompressed dense vectors (dense_vectorfields withint4orint8quantization strategies) and high dimensionality. Refer to documentation about billing dimensions for the impact to virtual compute unit (VCU) consumption.
- The
-
Values:
general_purposevector - Elasticsearch Serverless billing dimensions
-
search_lakeElasticsearchSearchLake -
Configuration for entire set of capabilities that make the data searchable in Elasticsearch.
-
search_powerinteger · min: 28 · max: 3000 -
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.
-
boost_windowinteger · min: 1 · max: 180 -
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.
-
min_search_vcuinteger · min: 2 · max: 2500 -
The minimum number of search VCUs allocated to your project.
-
endpointsElasticsearchProjectEndpointsrequired -
The endpoints to access the different apps of the project.
-
elasticsearchstringrequired -
The endpoint to access elasticsearch.
-
kibanastringrequired -
The endpoint to access kibana.
-
private_endpointsElasticsearchProjectPrivateEndpoints -
Private endpoints (URLs) for Elasticsearch projects when PrivateLink is enabled.
-
elasticsearchstringrequired -
The PrivateLink endpoint URL to access elasticsearch.
-
kibanastringrequired -
The PrivateLink endpoint URL to access kibana.
-
credentialsProjectCredentialsrequired -
Basic auth credentials to access the Elasticsearch API.
Response Headers
-
ETagstring
Bad request