Get Observability projects

GET /api/v1/serverless/projects/observability

The number of projects included can be configured with page_size. Consecutive calls can be made to retrieve next pages by providing a token.

Query parameters

  • page_size integer

    Maximum number of projects returned in the response.

    Minimum value is 0.

  • Token to the next page containing the list of projects.

Responses

  • 200 application/json

    The Observability project list

    Hide response attributes Show response attributes object
    • A token to fetch the next page.

    • items array[object] Required

      The actual projects.

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

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

GET /api/v1/serverless/projects/observability
curl \
 -X GET https://api.elastic-cloud.com/api/v1/serverless/projects/observability
Response examples (200)
{
  "next_page": "string",
  "items": [
    {
      "id": "string",
      "name": "my project",
      "alias": "my-project-alias",
      "region_id": "aws-us-east-1",
      "metadata": {
        "created_at": "2024-05-04T09:42:00+00:00",
        "created_by": "1014289666002276",
        "organization_id": "198583657190",
        "suspended_at": "2024-05-04T09:42:00+00:00",
        "suspended_reason": "trial expired"
      },
      "cloud_id": "my_project:LmF3cy5lbGFzdG",
      "type": "observability",
      "endpoints": {
        "elasticsearch": "string",
        "kibana": "string",
        "apm": "string",
        "ingest": "string"
      }
    }
  ]
}
Response examples (401)
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}