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 Security project list

  Hide response attributes Show response attributes object

  • next_page string

    A token to fetch the next page.

  • items array[object] Required

    The actual projects.

    Hide items attributes Show items attributes object

    A Security 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 security.

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

    • search_lake object

      Configuration for the entire set of capabilities that make the data searchable in Security.

      Additional properties are allowed.

      Hide search_lake attribute Show search_lake attribute object

      • data_retention object | null

        Configuration to control the data retention in Elasticsearch data streams.

        Additional properties are allowed.

        Hide data_retention attributes Show data_retention attributes object | null

        • max_retention_days integer | null

          Maximum number of days allowed for retaining data in Elasticsearch data streams. Can be set to "null" for unlimited. A default of 396 will be applied if no value is specified on project creation.

          Minimum value is 7, maximum value is 3681.

        • default_retention_days integer | null

          Default number of days during which data remains available in Elasticsearch data streams. Can be set to "null" for unlimited. A default of 396 will be applied if no value is specified on project creation.

          Minimum value is 7, maximum value is 3681.

    • admin_features_package string

      admin features package (BYOK, BYOIDP, CCS, CCR)

      Values are standard or enterprise.

    • product_types array[object]

      At least 2 but not more than 3 elements. Default value is [{"product_line"=>"security", "product_tier"=>"complete"}, {"product_line"=>"cloud", "product_tier"=>"complete"}, {"product_line"=>"endpoint", "product_tier"=>"complete"}].

      Hide product_types attributes Show product_types attributes object

      • product_line string Required

        The identifier of the Security Solution product line.

        Values are security, cloud, or endpoint.

      • product_tier string Required

        The identifier of the Security Solution product tier.

        Values are complete or essentials.

• 401 application/json

  Unauthorized

  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.