Responses

• 201 application/json

  The created observability project.

  Hide headers attribute Show headers attribute

  • ETag string
  Hide response attributes Show response attributes object

  The created Observability project along with credentials to access Elasticsearch.

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

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

    • apm string Required

      The endpoint to access apm.

    • ingest string Required

      The endpoint to access hosted otel collector.

  • credentials object Required

    Basic auth credentials to access the Elasticsearch API.

    Additional properties are allowed.

    Hide credentials attributes Show credentials attributes object

    • username string Required

      Basic auth username that can be used to access the Elasticsearch API.

    • password string Required

      Basic auth password that can be used to access the Elasticsearch API.

• 400 application/json

  Bad request

  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.

• 422 application/json

  Unprocessable entity

  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.