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

  Hide headers attribute Show headers attribute

  • ETag string
  Hide response attributes Show response 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 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 security.

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

    • ingest string Required

      The endpoint to access the Managed OTLP Endpoint.

  • private_endpoints object

    Private endpoints (URLs) for Security 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.

    • ingest string Required

      The PrivateLink endpoint URL to access the Managed OTLP Endpoint.

  • search_lake object

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

    Hide search_lake attribute Show search_lake attribute object

    • data_retention object | null

      Configuration to control the data retention in Elasticsearch data streams.

      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 1 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

    Defines Security product type object with product line and tier dimensions.

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

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