Elastic Observability · OpenAPI Overlay 1.0.0

API Evangelist enhancements — Observability Intake event intake API (event-intake)

2 actions 2 updates servers extends openapi/elastic-observability-event-intake-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Elastic Observability's API. It is a proposal applied on top of the contract, not a document Elastic Observability publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

serversx-write-semantics

Targets 2

$
$.info

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements — Observability Intake event intake API (event-intake)
  version: 1.0.0
extends: openapi/elastic-observability-event-intake-api-openapi.yml
x-provenance:
  generated: '2026-08-29'
  method: generated
  source: Derived from Elastic's own documentation; never mutates openapi/_original/elastic-observability-observability-intake-openapi.yml.
actions:
- target: $
  description: 'Replace the placeholder relative server with the real deployment-scoped hosts Elastic
    documents. The published contract ships servers: [{url: ''/''}], which names no host at all; Elastic
    documents the Elastic Cloud APM Server address as https://<hash>.apm.<region>.cloud.es.io:443 and
    the self-managed default as http://localhost:8200.'
  update:
    servers:
    - url: https://{deployment}.apm.{region}.cloud.es.io:443
      description: Elastic Cloud Hosted APM Server — deployment-scoped host, from the Elastic Cloud console
      variables:
        deployment:
          default: deployment
          description: Deployment hash from the Elastic Cloud console
        region:
          default: us-east-1
          description: Elastic Cloud region
    - url: http://{host}:{port}
      description: Self-managed / Elastic Cloud Enterprise APM Server
      variables:
        host:
          default: localhost
        port:
          default: '8200'
- target: $.info
  description: State the append-only, non-reversible, non-idempotent semantics of this write surface,
    which the contract does not say anywhere. See conventions/elastic-observability-conventions.yml.
  update:
    x-write-semantics:
      idempotent: false
      idempotency_key: null
      reversible: false
      note: Append-only telemetry ingest. Re-sending a batch duplicates events; there is no cancel, void
        or delete operation. Treat an ambiguous response as possibly-delivered.