Update an Observability project

PATCH /api/v1/serverless/projects/observability/{id}

Only the fields included in the body of the request will be updated.

Headers

  • If-Match string

    ETag value fetched in a previous GET project request. Used to prevent simultaneous updates

Path parameters

  • id string Required

    The ID of the project

    Format should match the following pattern: ^[a-z0-9]{32}$.

application/json

Body Required

The patched Observability project

  • name string

    Descriptive name for a project.

    Minimum length is 1, maximum length is 255.

  • alias string

    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})?$.

Responses

  • 200 application/json

    The updated Observability project.

    Hide headers attribute Show headers attribute
    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 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.
  • 404 application/json

    Not Found

    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.
  • 409 application/json

    Conflict

    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.
  • 412 application/json

    Precondition failed

    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.
PATCH /api/v1/serverless/projects/observability/{id} 
curl \
 -X PATCH https://api.elastic-cloud.com/api/v1/serverless/projects/observability/{id} \
 -H "Content-Type: application/json" \
 -H "If-Match: string" \
 -d '{"name":"Example project"}'
Request example 
{
  "name": "Example project"
}
Response examples (200) 
# Headers
ETag: string

# Payload
{
  "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 (404) 
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}
Response examples (409) 
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}
Response examples (412) 
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}