Update an Elasticsearch project

PATCH /api/v1/serverless/projects/elasticsearch/{id}

Only the fields included in the body of the request will be updated.

Headers

If-Match string

ETag value fetched in a previous GET project request. Used to prevent simultaneous updates

Path parameters

id string Required

The ID of the project

Format should match the following pattern: ^[a-z0-9]{32}$.

application/json

Body Required

The Elasticsearch project patch body

name string

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})?$.
search_lake object | null

Configuration for entire set of capabilities that make the data searchable in Elasticsearch. It can be passed as null to reset configuration to the default values.

Additional properties are allowed.
Hide search_lake attributes Show search_lake attributes object | null
- search_power integer | null
  
  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. It can be passed as null to reset the Search Power to the default value.
  
  Minimum value is 28, maximum value is 3000.
- boost_window integer | null
  
  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. It can be passed as null to reset the Search Boost Window to the default value.
  
  Minimum value is 1, maximum value is 180.

Responses

200 application/json

The updated Elasticsearch project.
Hide headers attribute Show headers attribute
- ETag string
Hide response attributes Show response attributes object
An Elasticsearch serverless project.
- 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.
  
  Additional properties are allowed.
  
  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.
  
  Additional properties are allowed.
  
  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 28, 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.
  
  Additional properties are allowed.
  
  Hide endpoints attributes Show endpoints attributes object
  
  elasticsearch string Required
  
  The endpoint to access elasticsearch.
  
  kibana string Required
  
  The endpoint to access kibana.
404 application/json

Not Found
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.
409 application/json

Conflict
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.
412 application/json

Precondition failed
Hide response attribute Show response attribute object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  A human-readable message of the error.
  
  code string Required
  
  An identifier for this type of error.

PATCH /api/v1/serverless/projects/elasticsearch/{id}

curl \
 -X PATCH https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/{id} \
 -H "Content-Type: application/json" \
 -H "If-Match: string" \
 -d '{"name":"Example project"}'

Request example

{
  "name": "Example project"
}

Response examples (200)

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

Response examples (404)

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

Response examples (409)

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

Response examples (412)

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