Update an Observability project

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

Api key

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
- ETag string
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.
  
  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.
  
  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
  
  An error response returned by the API.
  
  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
  
  An error response returned by the API.
  
  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
  
  An error response returned by the API.
  
  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 \
 --request PATCH 'https://api.elastic-cloud.com/api/v1/serverless/projects/observability/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "If-Match: string" \
 --data '{"name":"Example project"}'

Request example

{
  "name": "Example project"
}