Change Updates

Do not miss any Kibana API changes, ever again

Subscribe to the Kibana API changelog to be up to date on recent changes.

RSS

10 days ago

v8
1.0.2
Compare

API structure has changed

Next Change

This documentation update aligns with the 8.17.0 release. Refer to the Kibana Release Notes and Highlights

21 structure changes including:
12 Additions
9 Modifications
Modified 9 Breaking
PUT /api/alerting/rule/{id}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • monitoring property Modified
        • run property Modified
      • snooze_schedule property Modified
        • rRule property Modified
POST /s/{spaceId}/api/observability/slos/{sloId}/disable
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
POST /s/{spaceId}/api/observability/slos/{sloId}/_reset
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /api/apm/services/{serviceName}/annotation
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • @timestamp property Modified
      • Property is now required
        Breaking
    • service property Modified
      • Property is now required
        Breaking
      • version property Modified
        • Property is now required
          Breaking
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • _source property Modified
        • annotation property Modified
          • Type went from string to object
            Breaking
  • 400, 401, 403, 404 responses Added
  • Header
  • elastic-api-version, kbn-xsrf headers Added
POST /api/apm/agent_keys
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • name, privileges properties Modified
      • Properties are now required
        Breaking
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • api_key, encoded, expiration, id, name properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • agentKey property Added
  • 400, 401, 403, 500 responses Added
  • Header
  • elastic-api-version, kbn-xsrf headers Added
POST /api/alerting/rule/{id}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • monitoring property Modified
        • run property Modified
      • snooze_schedule property Modified
        • rRule property Modified
GET /api/apm/services/{serviceName}/annotation/search
  • Header
  • elastic-api-version header Added
  • Response
  • 400, 401, 500 responses Added
GET /api/alerting/rules/_find
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • monitoring property Modified
        • run property Modified
      • snooze_schedule property Modified
        • rRule property Modified
GET /api/alerting/rule/{id}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • monitoring property Modified
        • run property Modified
      • snooze_schedule property Modified
        • rRule property Modified
Added 12
PUT /api/apm/settings/agent-configuration
POST /api/cases/{caseId}/files
POST /api/apm/sourcemaps
POST /api/apm/settings/agent-configuration/search
POST /api/apm/fleet/apm_server_schema
GET /api/apm/sourcemaps
GET /api/apm/settings/agent-configuration/view
GET /api/apm/settings/agent-configuration/environments
GET /api/apm/settings/agent-configuration/agent_name
GET /api/apm/settings/agent-configuration
DELETE /api/apm/sourcemaps/{id}
DELETE /api/apm/settings/agent-configuration