Query parameters

• page_size integer

  Maximum number of projects returned in the response.

  Minimum value is 0.

• next_page string

  Token to the next page containing the list of projects.

Responses

• 200 application/json

  The Elasticsearch project list

  Hide response attributes Show response attributes object

  A paginated list of serverless elasticsearch projects.

  • next_page string

    A token to fetch the next page.

  • items array[object] Required

    The actual projects.

    Hide items attributes Show items 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.

      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.

• 401 application/json

  Unauthorized

  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.