Path parameters

• id string Required

  The ID of the project

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

Responses

• 200 application/json

  The requested 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 domain label compatible with RFC-1035 standards. Project alias with a unique suffix added by the system to avoid naming conflicts.

    Minimum length is 8, maximum length is 57. 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.

    • tags object

      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.

      Hide tags attribute Show tags attribute object

      • * string Additional properties

        Minimum length is 1, maximum length is 128. Format should match the following pattern: ^[a-z0-9][a-z0-9_-]*$.

    • system_tags object

      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.

      Hide system_tags attribute Show system_tags attribute object

      • * string Additional properties

        Minimum length is 1, maximum length is 128. Format should match the following pattern: ^[a-z0-9][a-z0-9_-]*$.

  • 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.

  • traffic_filters array[object]

    traffic filters IDs

    Hide traffic_filters attribute Show traffic_filters attribute object

    traffic filters association info

    • id string Required

      traffic filter ID

  • linked object

    Configuration for projects linked to this project

    Additional properties are NOT allowed.

    Hide linked attribute Show linked attribute object

    • projects object Required
      Hide projects attribute Show projects attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • status string Required

          The state of the linked project.

          Values are enabled, suspended, or deleted.

        • type string Required

          The type of the linked project

          Values are elasticsearch, observability, security, or workplaceai.

  • 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. Also known as the Elasticsearch project subtype.

    • The general_purpose option 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 vector option is recommended only for uncompressed dense vectors (dense_vector fields with int4 or int8 quantization strategies) and high dimensionality. Refer to documentation about billing dimensions for the impact to virtual compute unit (VCU) consumption.

    Values are general_purpose or vector.

    Elasticsearch Serverless billi...
  • 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 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.

    Hide endpoints attributes Show endpoints attributes object

    • elasticsearch string Required

      The endpoint to access elasticsearch.

    • kibana string Required

      The endpoint to access kibana.

  • private_endpoints object

    Private endpoints (URLs) for Elasticsearch projects when PrivateLink is enabled.

    Hide private_endpoints attributes Show private_endpoints attributes object

    • elasticsearch string Required

      The PrivateLink endpoint URL to access elasticsearch.

    • kibana string Required

      The PrivateLink endpoint URL 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

    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.