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

  details#setActive"> Hide headers attribute Show headers attribute

  • ETag string
  details#setActive"> Hide response attributes Show response attributes object

  An Observability 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.

    details#setActive"> 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.

  • traffic_filters array[object]

    traffic filters IDs

    traffic filters association info

    details#setActive"> Hide traffic_filters attribute Show traffic_filters attribute object

    • id string Required

      traffic filter ID

  • type string Required

    the type of the project

    Value is observability.

  • endpoints object Required

    The endpoints to access the different apps of the project.

    details#setActive"> Hide endpoints attributes Show endpoints attributes object

    • elasticsearch string Required

      The endpoint to access elasticsearch.

    • kibana string Required

      The endpoint to access kibana.

    • apm string Required

      The endpoint to access apm.

    • ingest string Required

      The endpoint to access hosted otel collector.

• 404 application/json

  Not Found

  details#setActive"> Hide response attribute Show response attribute object

  • errors array[object] Required

    An error response returned by the API.

    details#setActive"> 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.