Change Updates

Do not miss any Elastic APIs Hub changes, ever again

Subscribe to the Elastic APIs Hub changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Elasticsearch API
32 structure changes including:
32 Modifications
Modified 32 Breaking
DELETE /_autoscaling/policy/{name}
  • Query
  • master_timeout, timeout query parameters Added
GET /_autoscaling/capacity
  • Query
  • master_timeout query parameter Added
GET /_autoscaling/policy/{name}
  • Query
  • master_timeout query parameter Added
GET /_index_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Added
GET /_query_rules
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results property Modified
        • rule_type_counts property Added
GET /_security/_authenticate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_key property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/_query/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
GET /_security/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/privilege/_builtin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • remote_cluster property Added
GET /_security/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster properties Added
GET /_security/role/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster properties Added
GET /_security/service
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/service/{namespace}/{service}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • role_descriptor property Modified
GET /_security/user/_privileges
  • Response
  • 200 response Modified
    • application/json content type Modified
      • indices property Modified
        • names property Modified

          • Combinator is now oneOf

GET /{index}/_migration/deprecations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data_streams property Added
POST /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
POST /_security/_query/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
POST /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
POST /_security/api_key/grant
  • Body
  • application/json content type Modified
    • api_key property Modified
      • role_descriptors property Modified
        • object-1, array-2 alternatives Modified
POST /_security/cross_cluster/api_key
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • names property Modified

          • Combinator is now oneOf

        • allow_restricted_indices property Added
      • search property Modified
        • names property Modified

          • Combinator is now oneOf

POST /_security/role
  • Body
  • application/json content type Modified
    • roles property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
POST /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified

        • Combinator is now oneOf

        • names alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • _types:IndexName, array-2 alternatives Added
    • remote_indices property Modified
      • names property Modified

        • Combinator is now oneOf

        • names alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • _types:IndexName, array-2 alternatives Added
    • remote_cluster property Added
POST /{index}/_pit
  • Query
  • allow_partial_search_results query parameter Added
PUT /_autoscaling/policy/{name}
  • Query
  • master_timeout, timeout query parameters Added
PUT /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
PUT /_security/api_key/{id}
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • remote_indices, remote_cluster, restriction properties Added
PUT /_security/cross_cluster/api_key/{id}
  • Body
  • application/json content type Modified
    • access property Modified
      • replication property Modified
        • names property Modified

          • Combinator is now oneOf

        • allow_restricted_indices property Added
      • search property Modified
        • names property Modified

          • Combinator is now oneOf

PUT /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified

        • Combinator is now oneOf

        • names alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • _types:IndexName, array-2 alternatives Added
    • remote_indices property Modified
      • names property Modified

        • Combinator is now oneOf

        • names alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • _types:IndexName, array-2 alternatives Added
    • remote_cluster property Added
Kibana Serverless API
9 structure changes including:
2 Additions
7 Modifications
Modified 7
GET /api/fleet/agent_policies
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • advanced_settings property Modified
GET /api/fleet/agent_policies/{agentPolicyId}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
GET /api/fleet/agent_policies/{agentPolicyId}/full
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-2 alternative Modified
POST /api/fleet/agent_policies
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • advanced_settings property Modified
      • agent_logging_files_interval, agent_logging_files_keepfiles, agent_logging_files_rotateeverybytes, agent_logging_to_files properties Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
POST /api/fleet/agent_policies/_bulk_get
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • advanced_settings property Modified
POST /api/fleet/agent_policies/{agentPolicyId}/copy
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
PUT /api/fleet/agent_policies/{agentPolicyId}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • advanced_settings property Modified
      • agent_logging_files_interval, agent_logging_files_keepfiles, agent_logging_files_rotateeverybytes, agent_logging_to_files properties Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
Added 2
GET /api/entity_store/status
POST /api/entity_store/enable
Kibana API
17 structure changes including:
3 Additions
8 Modifications
6 Removals
Modified 8
GET /api/fleet/agent_policies
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • advanced_settings property Modified
GET /api/fleet/agent_policies/{agentPolicyId}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
GET /api/fleet/agent_policies/{agentPolicyId}/full
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-2 alternative Modified
GET /api/fleet/enrollment_api_keys
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • list property Added
POST /api/fleet/agent_policies
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • advanced_settings property Modified
      • agent_logging_files_interval, agent_logging_files_keepfiles, agent_logging_files_rotateeverybytes, agent_logging_to_files properties Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
POST /api/fleet/agent_policies/_bulk_get
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • advanced_settings property Modified
POST /api/fleet/agent_policies/{agentPolicyId}/copy
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
PUT /api/fleet/agent_policies/{agentPolicyId}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • advanced_settings property Modified
      • agent_logging_files_interval, agent_logging_files_keepfiles, agent_logging_files_rotateeverybytes, agent_logging_to_files properties Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • advanced_settings property Modified
Removed 6
POST /api/endpoint/unisolate
POST /api/endpoint/suggestions/{suggestion_type}
POST /api/endpoint/isolate
GET /api/endpoint/policy/summaries
GET /api/endpoint/metadata/transforms
GET /api/endpoint/action_log/{agent_id}
Added 3
POST /api/entity_store/enable
POST /api/cases/{caseId}/files
GET /api/entity_store/status
Kibana Serverless API
5 structure changes including:
1 Modification
4 Removals
Modified 1
GET /api/fleet/enrollment_api_keys
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • list property Added
Removed 4
GET /api/endpoint/action_log/{agent_id}
GET /api/endpoint/metadata/transforms
GET /api/endpoint/policy/summaries
POST /api/endpoint/suggestions/{suggestion_type}
Elasticsearch Serverless API
14 structure changes including:
14 Modifications
Modified 14
GET /_index_template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_index_template/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index_templates property Modified
        • index_template property Modified
GET /_query_rules
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results property Modified
        • rule_type_counts property Added
GET /_security/_authenticate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_key property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
GET /_security/role
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
GET /_security/role/{name}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • indices property Modified
POST /_security/_query/api_key
  • Response
  • 200 response Modified
    • application/json content type Modified
      • api_keys property Modified
        • role_descriptors, limited_by properties Modified
POST /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • restriction property Added
POST /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified

        • Combinator is now oneOf

        • names alternative Removed
        • _types:IndexName, array-2 alternatives Added
PUT /_security/api_key
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • restriction property Added
PUT /_security/api_key/{id}
  • Body
  • application/json content type Modified
    • role_descriptors property Modified
      • * property Modified
        • indices property Modified
        • restriction property Added
PUT /_security/role/{name}
  • Body
  • application/json content type Modified
    • indices property Modified
      • names property Modified

        • Combinator is now oneOf

        • names alternative Removed
        • _types:IndexName, array-2 alternatives Added
Kibana API

This documentation update aligns with Kibana version 8.16.0, which has the following release notes: https://www.elastic.co/guide/en/kibana/8.16/release-notes-8.16.0.html

244 structure changes including:
23 Breaking changes
190 Additions
29 Modifications
25 Removals
Modified 29 Breaking
PUT /api/fleet/agent_policies/{agentPolicyId}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • global_data_tags property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • package_policies property Modified
        • monitoring_diagnostics, monitoring_http, monitoring_pprof_enabled properties Added
  • Query
  • format query parameter Added
PUT /api/fleet/package_policies/{packagePolicyId}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • policy_id property Modified

      • Type went from string to string | null

    • output_id property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • output_id property Modified

          • Property is no longer deprecated

        • policy_id property Modified

          • Type went from string to string | null

      • sucess property Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

PUT /api/fleet/settings
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • delete_unenrolled_agents property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • delete_unenrolled_agents property Added
PUT /s/{spaceId}/api/observability/slos/{sloId}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • groupBy property Added
      • string-1, array-2 properties Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • groupBy property Modified

        • Combinator is now oneOf

        • groupBy alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • string-1, array-2 alternatives Added
PUT /api/detection_engine/rules
  • Path went from `/api/alerting/rule/{ruleId}` to `/api/detection_engine/rules` (same operationId)
    Breaking
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • alternative Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • Security_Detections_API_EqlRuleCreateFields, Security_Detections_API_QueryRuleCreateFields, Security_Detections_API_SavedQueryRuleCreateFields, Security_Detections_API_ThresholdRuleCreateFields, Security_Detections_API_ThreatMatchRuleCreateFields, Security_Detections_API_MachineLearningRuleCreateFields, Security_Detections_API_NewTermsRuleCreateFields, Security_Detections_API_EsqlRuleCreateFields alternatives Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • alternative Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • Security_Detections_API_EqlRuleResponseFields, Security_Detections_API_QueryRuleResponseFields, Security_Detections_API_SavedQueryRuleResponseFields, Security_Detections_API_ThresholdRuleResponseFields, Security_Detections_API_ThreatMatchRuleResponseFields, Security_Detections_API_MachineLearningRuleResponseFields, Security_Detections_API_NewTermsRuleResponseFields, Security_Detections_API_EsqlRuleResponseFields alternatives Added
  • 401, 404 responses Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Header
  • kbn-xsrf header Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Path
  • ruleId path parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /s/{spaceId}/api/observability/slos/{sloId}/_reset
  • Response
  • 204 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • groupBy property Modified

        • Combinator is now oneOf

        • groupBy alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • string-1, array-2 alternatives Added
POST /s/{spaceId}/api/observability/slos
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • groupBy property Modified

      • Combinator is now oneOf

      • groupBy alternative Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • string-1, array-2 alternatives Added
POST /api/fleet/package_policies/upgrade/dryrun
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • diff property Modified
        • output_id property Modified

          • Property is no longer deprecated

        • policy_id property Modified

          • Type went from string to string | null

POST /api/fleet/package_policies/_bulk_get
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • output_id property Modified

          • Property is no longer deprecated

        • policy_id property Modified

          • Type went from string to string | null

POST /api/fleet/package_policies
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • policy_id property Modified

      • Type went from string to string | null

    • output_id property Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • output_id property Modified

          • Property is no longer deprecated

        • policy_id property Modified

          • Type went from string to string | null

POST /api/fleet/enrollment_api_keys
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Added
POST /api/fleet/agents/actions/{actionId}/cancel
  • Path went from `/api/fleet/agents/{agentId}/actions/{actionId}/cancel` to `/api/fleet/agents/actions/{actionId}/cancel` (same operationId)
    Breaking
  • Path
  • agentId path parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /api/fleet/agent_policies/{agentPolicyId}/copy
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • package_policies property Modified
        • monitoring_diagnostics, monitoring_http, monitoring_pprof_enabled properties Added
  • Query
  • format query parameter Added
POST /api/fleet/agent_policies/_bulk_get
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • package_policies property Modified
        • monitoring_diagnostics, monitoring_http, monitoring_pprof_enabled properties Added
  • Query
  • format query parameter Added
POST /api/fleet/agent_policies
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • package_policies property Modified
        • monitoring_diagnostics, monitoring_http, monitoring_pprof_enabled properties Added
POST /api/detection_engine/rules
  • Path went from `/api/alerting/rule` to `/api/detection_engine/rules` (same operationId)
    Breaking
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • Alerting_create_anomaly_detection_alert_rule_request, Alerting_create_anomaly_detection_jobs_health_rule_request, Alerting_create_apm_anomaly_rule_request, Alerting_create_apm_error_count_rule_request, Alerting_create_apm_transaction_duration_rule_request, Alerting_create_apm_transaction_error_rate_rule_request, Alerting_create_es_query_rule_request, Alerting_create_geo_containment_rule_request, Alerting_create_index_threshold_rule_request, Alerting_create_infra_inventory_rule_request, Alerting_create_infra_metric_anomaly_rule_request, Alerting_create_infra_metric_threshold_rule_request, Alerting_create_monitoring_jvm_memory_usage_rule_request, Alerting_create_log_threshold_rule_request, Alerting_create_monitoring_ccr_exceptions_rule_request, Alerting_create_monitoring_cluster_health_rule_request, Alerting_create_monitoring_cpu_usage_rule_request, Alerting_create_monitoring_disk_usage_rule_request, Alerting_create_monitoring_elasticsearch_version_mismatch_rule_request, Alerting_create_monitoring_license_expiration_rule_request, Alerting_create_monitoring_kibana_version_mismatch_rule_request, Alerting_create_monitoring_logstash_version_mismatch_rule_request, Alerting_create_monitoring_missing_data_rule_request, Alerting_create_monitoring_nodes_changed_rule_request, Alerting_create_monitoring_shard_size_rule_request, Alerting_create_monitoring_thread_pool_search_rejections_rule_request, Alerting_create_monitoring_thread_pool_write_rejections_rule_request, Alerting_create_siem_eql_rule_request, Alerting_create_siem_indicator_rule_request, Alerting_create_siem_ml_rule_request, Alerting_create_siem_new_terms_rule_request, Alerting_create_siem_notifications_rule_request, Alerting_create_siem_query_rule_request, Alerting_create_siem_saved_query_rule_request, Alerting_create_siem_threshold_rule_request, Alerting_create_slo_burn_rate_rule_request, Alerting_create_synthetics_monitor_status_rule_request, Alerting_create_synthetics_uptime_duration_anomaly_rule_request, Alerting_create_synthetics_uptime_tls_rule_request, Alerting_create_synthetics_uptime_tls_certificate_rule_request, Alerting_create_transform_health_rule_request, Alerting_create_uptime_monitor_status_rule_request alternatives Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • Security_Detections_API_EqlRuleCreateFields, Security_Detections_API_QueryRuleCreateFields, Security_Detections_API_SavedQueryRuleCreateFields, Security_Detections_API_ThresholdRuleCreateFields, Security_Detections_API_ThreatMatchRuleCreateFields, Security_Detections_API_MachineLearningRuleCreateFields, Security_Detections_API_NewTermsRuleCreateFields, Security_Detections_API_EsqlRuleCreateFields alternatives Added
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • alternative Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • Security_Detections_API_EqlRuleResponseFields, Security_Detections_API_QueryRuleResponseFields, Security_Detections_API_SavedQueryRuleResponseFields, Security_Detections_API_ThresholdRuleResponseFields, Security_Detections_API_ThreatMatchRuleResponseFields, Security_Detections_API_MachineLearningRuleResponseFields, Security_Detections_API_NewTermsRuleResponseFields, Security_Detections_API_EsqlRuleResponseFields alternatives Added
  • 401, 404 responses Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Header
  • kbn-xsrf header Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /s/{spaceId}/api/observability/slos/{sloId}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • groupBy property Modified

        • Combinator is now oneOf

        • groupBy alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • string-1, array-2 alternatives Added
GET /s/{spaceId}/api/observability/slos
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • results property Modified
        • groupBy property Modified

          • Combinator is now oneOf

GET /api/fleet/settings
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • delete_unenrolled_agents property Added
GET /api/fleet/package_policies/{packagePolicyId}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • output_id property Modified

          • Property is no longer deprecated

        • policy_id property Modified

          • Type went from string to string | null

GET /api/fleet/package_policies
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • output_id property Modified

          • Property is no longer deprecated

        • policy_id property Modified

          • Type went from string to string | null

GET /api/fleet/epm/packages/{pkgkey}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Modified
        • agent, asset_tags, discovery, owner properties Added
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • agent, asset_tags, discovery, owner properties Added
GET /api/fleet/enrollment_api_keys
  • Query
  • perPage, page, kuery query parameters Added
GET /api/fleet/agent_policies/{agentPolicyId}/full
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-2 alternative Modified
GET /api/fleet/agent_policies/{agentPolicyId}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • package_policies property Modified
        • monitoring_diagnostics, monitoring_http, monitoring_pprof_enabled properties Added
  • Query
  • format query parameter Added
GET /api/fleet/agent_policies
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • package_policies property Modified
        • monitoring_diagnostics, monitoring_http, monitoring_pprof_enabled properties Added
  • Query
  • format query parameter Added
GET /api/detection_engine/rules/_find
  • Path went from `/api/alerting/rules/_find` to `/api/detection_engine/rules/_find` (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • data property Modified

        • Property is now required

          Breaking

        • Alerting_rule_response_properties alternative Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

        • Security_Detections_API_EqlRuleResponseFields, Security_Detections_API_QueryRuleResponseFields, Security_Detections_API_SavedQueryRuleResponseFields, Security_Detections_API_ThresholdRuleResponseFields, Security_Detections_API_ThreatMatchRuleResponseFields, Security_Detections_API_MachineLearningRuleResponseFields, Security_Detections_API_NewTermsRuleResponseFields, Security_Detections_API_EsqlRuleResponseFields alternatives Added
      • page, total properties Modified

        • Properties are now required

          Breaking

      • per_page property Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • perPage property Added
  • 401 response Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Query
  • default_search_operator, has_reference, search, search_fields query parameters Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

DELETE /api/detection_engine/rules
  • Path went from `/api/alerting/rule/{ruleId}` to `/api/detection_engine/rules` (same operationId)
    Breaking
  • Header
  • kbn-xsrf header Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Path
  • ruleId path parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • Response
  • 204, 401, 404 responses Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • 200 response Added
  • Query
  • id, rule_id query parameters Added
Removed 25 Breaking
PUT /api/actions/connector/{connectorId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/actions/action/{actionId}
POST /api/alerting/rule/{ruleId}/alert/{alertId}/_unmute
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{ruleId}/alert/{alertId}/_mute
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{ruleId}/_update_api_key
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{ruleId}/_unmute_all
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{ruleId}/_mute_all
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{ruleId}/_enable
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{ruleId}/_disable
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{ruleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/actions/connector/{connectorId}/_execute
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/actions/connector/{connectorId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/actions/action/{actionId}
DELETE /api/actions/connector/{connectorId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/actions
GET /api/actions/action/{actionId}
GET /api/actions/connector/{connectorId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/actions/connector_types
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/actions/connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/actions/list_action_types
GET /api/alerting/rule/{ruleId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/status
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/actions
POST /api/actions/action/{actionId}/_execute
POST /api/actions/connector
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 190
POST /api/endpoint_list/items
POST /api/entity_store/engines/apply_dataview_indices
POST /api/entity_store/engines/{entityType}/init
POST /api/entity_store/engines/{entityType}/start
POST /api/entity_store/engines/{entityType}/stats
POST /api/entity_store/engines/{entityType}/stop
POST /api/exception_lists
POST /api/exception_lists/_duplicate
POST /api/exception_lists/_export
POST /api/exception_lists/_import
POST /api/exception_lists/items
POST /api/exceptions/shared
POST /api/lists
POST /api/lists/index
POST /api/lists/items
POST /api/lists/items/_export
POST /api/lists/items/_import
POST /api/detection_engine/signals/search
POST /api/detection_engine/signals/status
POST /api/detection_engine/signals/tags
POST /api/endpoint/action/execute
POST /api/endpoint/action/get_file
POST /api/endpoint/action/isolate
POST /api/endpoint/action/kill_process
POST /api/endpoint/action/running_procs
POST /api/endpoint/action/scan
POST /api/endpoint/action/suspend_process
POST /api/endpoint/action/unisolate
POST /api/endpoint/action/upload
POST /api/endpoint/isolate
POST /api/endpoint/protection_updates_note/{package_policy_id}
POST /api/endpoint/suggestions/{suggestion_type}
POST /api/endpoint/unisolate
POST /api/endpoint_list
POST /api/timeline/_import
POST /api/timeline/_prepackaged
PUT /api/actions/action/{id}
PUT /api/actions/connector/{id}
PUT /api/alerting/rule/{id}
PUT /api/detection_engine/rules/_bulk_update
PUT /api/detection_engine/rules/prepackaged
PUT /api/endpoint_list/items
PUT /api/exception_lists
PUT /api/exception_lists/items
PUT /api/lists
PUT /api/lists/items
PUT /api/osquery/packs/{id}
PUT /api/osquery/saved_queries/{id}
PUT /api/security/role/{name}
PUT /api/security_ai_assistant/current_user/conversations/{id}
PUT /api/spaces/space/{id}
POST /api/osquery/live_queries
POST /api/osquery/packs
POST /api/osquery/saved_queries
POST /api/risk_score/engine/schedule_now
POST /api/security/roles
POST /api/security_ai_assistant/anonymization_fields/_bulk_action
POST /api/security_ai_assistant/chat/complete
POST /api/security_ai_assistant/current_user/conversations
POST /api/security_ai_assistant/prompts/_bulk_action
POST /api/spaces/_copy_saved_objects
POST /api/spaces/_disable_legacy_url_aliases
POST /api/spaces/_get_shareable_references
POST /api/spaces/_update_objects_spaces
POST /api/spaces/space
POST /api/timeline
POST /api/timeline/_draft
POST /api/timeline/_export
DELETE /api/actions/action/{id}
GET /api/asset_criticality/list
GET /api/detection_engine/index
GET /api/detection_engine/privileges
GET /api/detection_engine/rules
GET /api/detection_engine/rules/prepackaged/_status
GET /api/detection_engine/tags
GET /api/endpoint/action
GET /api/endpoint/action/state
GET /api/endpoint/action/{action_id}
GET /api/endpoint/action/{action_id}/file/{file_id}
GET /api/endpoint/action/{action_id}/file/{file_id}/download
GET /api/endpoint/action_log/{agent_id}
GET /api/endpoint/action_status
GET /api/endpoint/metadata
GET /api/endpoint/metadata/transforms
GET /api/endpoint/metadata/{id}
GET /api/endpoint/policy/summaries
GET /api/endpoint/policy_response
GET /api/endpoint/protection_updates_note/{package_policy_id}
GET /api/endpoint_list/items
GET /api/endpoint_list/items/_find
GET /api/entity_store/engines
GET /api/entity_store/engines/{entityType}
GET /api/entity_store/entities/list
GET /api/exception_lists
GET /api/exception_lists/_find
GET /api/exception_lists/items
GET /api/exception_lists/items/_find
GET /api/exception_lists/summary
GET /api/lists
DELETE /api/actions/connector/{id}
DELETE /api/alerting/rule/{id}
DELETE /api/asset_criticality
DELETE /api/detection_engine/index
DELETE /api/detection_engine/rules/_bulk_delete
DELETE /api/detection_engine/signals/migration
DELETE /api/endpoint_list/items
DELETE /api/entity_store/engines/{entityType}
DELETE /api/exception_lists
DELETE /api/exception_lists/items
DELETE /api/lists
DELETE /api/lists/index
DELETE /api/lists/items
DELETE /api/note
DELETE /api/osquery/packs/{id}
DELETE /api/osquery/saved_queries/{id}
DELETE /api/risk_score/engine/dangerously_delete_data
DELETE /api/security/role/{name}
DELETE /api/security_ai_assistant/current_user/conversations/{id}
DELETE /api/spaces/space/{id}
DELETE /api/timeline
GET /api/actions
GET /api/actions/action/{id}
GET /api/actions/connector/{id}
GET /api/actions/connector_types
GET /api/actions/connectors
GET /api/actions/list_action_types
GET /api/alerting/rule/{id}
GET /api/alerting/rules/_find
GET /api/asset_criticality
GET /api/lists/_find
PATCH /api/note
PATCH /api/pinned_event
PATCH /api/timeline
PATCH /api/timeline/_favorite
POST /api/actions/action
POST /api/actions/action/{id}/_execute
POST /api/actions/connector/{id}
POST /api/actions/connector/{id}/_execute
POST /api/alerting/rule/{id}
POST /api/alerting/rule/{id}/_disable
POST /api/alerting/rule/{id}/_enable
POST /api/alerting/rule/{id}/_mute_all
POST /api/alerting/rule/{id}/_unmute_all
POST /api/alerting/rule/{id}/_update_api_key
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
POST /api/asset_criticality
POST /api/asset_criticality/bulk
POST /api/detection_engine/index
POST /api/detection_engine/rules/_bulk_action
POST /api/detection_engine/rules/_bulk_create
POST /api/detection_engine/rules/_bulk_delete
POST /api/detection_engine/rules/_export
POST /api/detection_engine/rules/_import
POST /api/detection_engine/rules/preview
POST /api/detection_engine/rules/{id}/exceptions
POST /api/detection_engine/signals/assignees
POST /api/detection_engine/signals/finalize_migration
POST /api/detection_engine/signals/migration
POST /api/detection_engine/signals/migration_status
GET /api/lists/index
GET /api/lists/items
GET /api/lists/items/_find
GET /api/lists/privileges
GET /api/note
GET /api/osquery/live_queries
GET /api/osquery/live_queries/{id}
GET /api/osquery/live_queries/{id}/results/{actionId}
GET /api/osquery/packs
GET /api/osquery/packs/{id}
GET /api/osquery/saved_queries
GET /api/osquery/saved_queries/{id}
GET /api/security/role
GET /api/security/role/{name}
GET /api/security_ai_assistant/anonymization_fields/_find
GET /api/security_ai_assistant/current_user/conversations/_find
GET /api/security_ai_assistant/current_user/conversations/{id}
GET /api/security_ai_assistant/prompts/_find
GET /api/spaces/space
GET /api/spaces/space/{id}
GET /api/status
GET /api/timeline
GET /api/timeline/_copy
GET /api/timeline/_draft
GET /api/timeline/resolve
GET /api/timelines
PATCH /api/detection_engine/rules
PATCH /api/detection_engine/rules/_bulk_update
PATCH /api/lists
PATCH /api/lists/items
Kibana API
20 structure changes including:
20 Modifications
Modified 20 Breaking
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /api/fleet/enrollment_api_keys
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • list property Removed
GET /api/fleet/epm/categories
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • Query
  • experimental query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /api/fleet/epm/packages
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • savedObject property Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

      • response property Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • Query
  • experimental query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /api/fleet/epm/packages/limited
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • savedObject property Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

      • response property Removed
GET /api/fleet/outputs
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • object-4 alternative Modified
GET /api/fleet/outputs/{outputId}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-4 alternative Modified
GET /api/fleet/settings
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • fleet_server_hosts property Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

POST /api/fleet/epm/custom_integrations
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/epm/packages
  • Response
  • 200 response Modified
    • application/gzip; application/zip; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/epm/packages/_bulk
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/health_check
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • host property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • host property Removed
POST /api/fleet/outputs
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • object-4 alternative Modified
      • topics property Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-4 alternative Modified
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 /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
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • savedObject property Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

      • response property Removed
PUT /api/fleet/outputs/{outputId}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • object-4 alternative Modified
      • topics property Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-4 alternative Modified
PUT /api/fleet/settings
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • fleet_server_hosts property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • fleet_server_hosts property Removed

          • Removing a resource is always breaking unless it was deprecated before

            Breaking

Kibana Serverless API
20 structure changes including:
20 Modifications
Modified 20
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Removed
GET /api/fleet/enrollment_api_keys
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • list property Removed
GET /api/fleet/epm/categories
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
  • Query
  • experimental query parameter Removed
GET /api/fleet/epm/packages
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • savedObject property Removed
      • response property Removed
  • Query
  • experimental query parameter Removed
GET /api/fleet/epm/packages/limited
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • savedObject property Removed
      • response property Removed
GET /api/fleet/outputs
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • items property Modified
        • object-4 alternative Modified
GET /api/fleet/outputs/{outputId}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-4 alternative Modified
GET /api/fleet/settings
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • fleet_server_hosts property Removed
POST /api/fleet/epm/custom_integrations
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/epm/packages
  • Response
  • 200 response Modified
    • application/gzip; application/zip; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/epm/packages/_bulk
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • response property Removed
POST /api/fleet/health_check
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • host property Removed
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • host property Removed
POST /api/fleet/outputs
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • object-4 alternative Modified
      • topics property Removed
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-4 alternative Modified
POST /s/{spaceId}/api/observability/slos/{sloId}/_reset
  • Response
  • 204 response Removed
  • 200 response Added
POST /s/{spaceId}/api/observability/slos/{sloId}/disable
  • Response
  • 200 response Removed
  • 204 response Added
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Path
  • pkgVersion path parameter Modified

    • Path parameter is no longer required

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • savedObject property Removed
      • response property Removed
PUT /api/fleet/outputs/{outputId}
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • object-4 alternative Modified
      • topics property Removed
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • object-4 alternative Modified
PUT /api/fleet/settings
  • Body
  • application/json; Elastic-Api-Version=2023-10-31 content type Modified
    • fleet_server_hosts property Removed
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • item property Modified
        • fleet_server_hosts property Removed
Elasticsearch API
31 structure changes including:
31 Modifications
Modified 31 Breaking
GET /_cat/allocation
  • Query
  • local query parameter Added
GET /_cat/allocation/{node_id}
  • Query
  • local query parameter Added
GET /_cat/component_templates
  • Query
  • local query parameter Added
GET /_cat/component_templates/{name}
  • Query
  • local query parameter Added
GET /_cat/master
  • Query
  • local query parameter Added
GET /_cat/nodeattrs
  • Query
  • local query parameter Added
GET /_cat/pending_tasks
  • Query
  • local query parameter Added
GET /_cat/plugins
  • Query
  • local query parameter Added
GET /_cat/segments
  • Query
  • local query parameter Added
GET /_cat/segments/{index}
  • Query
  • local query parameter Added
GET /_cat/templates
  • Query
  • local query parameter Added
GET /_cat/templates/{name}
  • Query
  • local query parameter Added
GET /_cat/thread_pool
  • Query
  • local query parameter Added
GET /_cat/thread_pool/{thread_pool_patterns}
  • Query
  • local query parameter Added
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure, processors properties Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure, processors properties Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
GET /_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /_tasks
  • Query
  • node_id query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • nodes query parameter Added
GET /{index}/_fleet/_fleet_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /{index}/_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /_async_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
POST /_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /_text_structure/find_structure
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ingest_pipeline property Modified
        • processors property Modified
POST /{index}/_async_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /{index}/_fleet/_fleet_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /{index}/_search
  • Query
  • min_compatible_shard_node query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

PUT /_ingest/pipeline/{id}
  • Body
  • application/json content type Modified
    • on_failure property Modified
      • ip_location property Added
    • processors property Modified
      • ip_location property Added
Elasticsearch Serverless API
15 structure changes including:
15 Modifications
Modified 15
GET /_cat/component_templates
  • Query
  • local query parameter Added
GET /_cat/component_templates/{name}
  • Query
  • local query parameter Added
GET /_ingest/pipeline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure, processors properties Modified
GET /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
GET /_ingest/pipeline/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • * property Modified
        • on_failure, processors properties Modified
GET /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
GET /_search
  • Query
  • min_compatible_shard_node query parameter Removed
GET /{index}/_search
  • Query
  • min_compatible_shard_node query parameter Removed
POST /_async_search
  • Query
  • min_compatible_shard_node query parameter Removed
POST /_ingest/pipeline/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
POST /_ingest/pipeline/{id}/_simulate
  • Body
  • application/json content type Modified
    • pipeline property Modified
      • on_failure property Modified
        • ip_location property Added
      • processors property Modified
        • ip_location property Added
POST /_search
  • Query
  • min_compatible_shard_node query parameter Removed
POST /{index}/_async_search
  • Query
  • min_compatible_shard_node query parameter Removed
POST /{index}/_search
  • Query
  • min_compatible_shard_node query parameter Removed
PUT /_ingest/pipeline/{id}
  • Body
  • application/json content type Modified
    • on_failure property Modified
      • ip_location property Added
    • processors property Modified
      • ip_location property Added
Elasticsearch API

This documentation update aligns with Elasticsearch version 8.16.0, which has the following release notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/release-notes-8.16.0.html

Elastic Cloud API
6 structure changes including:
6 Modifications
Modified 6
GET /billing/costs/{organization_id}
  • Operation is now deprecated
GET /billing/costs/{organization_id}/charts
  • Operation is now deprecated
GET /billing/costs/{organization_id}/deployments
  • Operation is now deprecated
GET /billing/costs/{organization_id}/deployments/{deployment_id}/charts
  • Operation is now deprecated
GET /billing/costs/{organization_id}/deployments/{deployment_id}/items
  • Operation is now deprecated
GET /billing/costs/{organization_id}/items
  • Operation is now deprecated
Elasticsearch API
15 structure changes including:
2 Additions
13 Modifications
Modified 13 Breaking
GET /_alias
  • Query
  • local query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /_alias/{name}
  • Query
  • local query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
GET /_segments
  • Query
  • verbose query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /_xpack
  • Response
  • 200 response Modified
    • application/json content type Modified
      • features property Modified
        • logsdb property Added
GET /{index}/_alias
  • Query
  • local query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /{index}/_alias/{name}
  • Query
  • local query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
GET /{index}/_segments
  • Query
  • verbose query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

HEAD /_alias/{name}
  • Query
  • local query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

HEAD /{index}/_alias/{name}
  • Query
  • local query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
POST /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
Added 2
POST /_security/cross_cluster/api_key
PUT /_security/cross_cluster/api_key/{id}
Elasticsearch Serverless API
10 structure changes including:
10 Modifications
Modified 10
GET /_alias
  • Query
  • local query parameter Removed
GET /_alias/{name}
  • Query
  • local query parameter Removed
GET /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
GET /{index}/_alias
  • Query
  • local query parameter Removed
GET /{index}/_alias/{name}
  • Query
  • local query parameter Removed
GET /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
HEAD /_alias/{name}
  • Query
  • local query parameter Removed
HEAD /{index}/_alias/{name}
  • Query
  • local query parameter Removed
POST /_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
POST /{index}/_search
  • Body
  • application/json content type Modified
    • retriever property Modified
      • knn property Modified
        • min_score property Added
      • rrf property Modified
        • min_score property Added
      • text_similarity_reranker, rule properties Added
Kibana API
289 structure changes including:
136 Breaking changes
147 Additions
6 Modifications
136 Removals
Modified 6 Breaking
GET /api/apm/services/{serviceName}/annotation/search
  • Header
  • elastic-api-version header Added
  • Response
  • 400, 401, 500 responses Added
GET /api/entity_store/engines
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • engines property Modified
        • error property Added
GET /api/entity_store/engines/{entityType}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • error property 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/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/entity_store/engines/{entityType}/init
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • error property Added
Removed 136 Breaking
GET /api/security/role/{name}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath*}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/packages/{pkgName}/stats
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/packages/limited
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/packages/installed
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/packages
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/data_streams
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/enrollment_api_keys/{keyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/enrollment_api_keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/data_streams
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/check-permissions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents/{agentId}/uploads
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents/{agentId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents/tags
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/security/role
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/uninstall_tokens/{uninstallTokenId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/uninstall_tokens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/settings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/proxies/{itemId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/proxies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/package_policies/{packagePolicyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/package_policies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/outputs/{outputId}/health
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/outputs/{outputId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/outputs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/kubernetes/download
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/kubernetes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/fleet_server_hosts/{itemId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/fleet_server_hosts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/epm/verification_key_id
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/actions/connectors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/actions/connector_types
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/actions/connector/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/spaces/space/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/security/role/{name}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/proxies/{itemId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/package_policies/{packagePolicyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/outputs/{outputId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/fleet_server_hosts/{itemId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/enrollment_api_keys/{keyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/agents/{agentId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/agents/files/{fileId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/fleet/agent_download_sources/{sourceId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/alerting/rule/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/actions/connector/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents/setup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents/files/{fileId}/{fileName}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents/available_versions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents/action_status
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agents
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_status/data
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_status
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_policies/{agentPolicyId}/outputs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_policies/{agentPolicyId}/full
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_policies/{agentPolicyId}/download
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_policies/{agentPolicyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_policies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_download_sources/{sourceId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/fleet/agent_download_sources
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/alerting/rules/_find
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/alerting/rule/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/security/roles
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/setup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/service_tokens
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/proxies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/package_policies/upgrade/dryrun
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/package_policies/upgrade
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/package_policies/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/package_policies/_bulk_get
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/package_policies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/outputs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/message_signing_service/rotate_key_pair
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/logstash_api_keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/health_check
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/fleet_server_hosts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/epm/packages/_bulk
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agent_policies/outputs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/spaces/space/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/security/role/{name}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/settings
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/proxies/{itemId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/package_policies/{packagePolicyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/outputs/{outputId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/fleet_server_hosts/{itemId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/agents/{agentId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/agent_policies/{agentPolicyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/fleet/agent_download_sources/{sourceId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/alerting/rule/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/actions/connector/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/spaces/space
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/spaces/_update_objects_spaces
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/spaces/_get_shareable_references
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/spaces/_disable_legacy_url_aliases
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/spaces/_copy_saved_objects
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agent_policies/delete
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agent_policies/_bulk_get
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agent_policies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agent_download_sources
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{id}/_update_api_key
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{id}/_unmute_all
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{id}/_mute_all
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{id}/_enable
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{id}/_disable
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/alerting/rule/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/actions/connector/{id}/_execute
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/actions/connector/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/status
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/spaces/space/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/spaces/space
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/epm/packages
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/epm/custom_integrations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/epm/bulk_assets
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/enrollment_api_keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/{agentId}/upgrade
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/{agentId}/unenroll
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/{agentId}/request_diagnostics
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/{agentId}/reassign
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/{agentId}/actions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/setup
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/bulk_upgrade
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/bulk_update_agent_tags
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/bulk_unenroll
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/bulk_request_diagnostics
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/bulk_reassign
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents/actions/{actionId}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agents
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/fleet/agent_policies/{agentPolicyId}/copy
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 147
PUT /api/spaces/space/{id}
PUT /api/security/role/{name}
PUT /api/fleet/settings
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath*}
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
GET /api/fleet/epm/packages/{pkgName}/stats
GET /api/fleet/epm/packages/limited
GET /api/fleet/epm/packages/installed
GET /api/fleet/epm/packages
GET /api/fleet/epm/data_streams
GET /api/fleet/epm/categories
GET /api/fleet/enrollment_api_keys/{keyId}
GET /api/fleet/enrollment_api_keys
GET /api/fleet/data_streams
GET /api/fleet/check-permissions
GET /api/fleet/agents/{agentId}/uploads
GET /api/fleet/agents/{agentId}
GET /api/fleet/agents/tags
GET /api/fleet/agents/setup
GET /api/fleet/agents/files/{fileId}/{fileName}
GET /api/fleet/agents/available_versions
GET /api/security/role/{name}
GET /api/security/role
GET /api/fleet/uninstall_tokens/{uninstallTokenId}
GET /api/fleet/uninstall_tokens
GET /api/fleet/settings
GET /api/fleet/proxies/{itemId}
GET /api/fleet/proxies
GET /api/fleet/package_policies/{packagePolicyId}
GET /api/fleet/package_policies
GET /api/fleet/outputs/{outputId}/health
GET /api/fleet/outputs/{outputId}
GET /api/fleet/outputs
GET /api/fleet/kubernetes/download
GET /api/fleet/kubernetes
GET /api/fleet/fleet_server_hosts/{itemId}
GET /api/fleet/fleet_server_hosts
GET /api/fleet/epm/verification_key_id
GET /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs
GET /api/actions/connectors
GET /api/actions/connector_types
GET /api/actions/connector/{id}
DELETE /api/spaces/space/{id}
DELETE /api/security/role/{name}
DELETE /api/fleet/proxies/{itemId}
DELETE /api/fleet/package_policies/{packagePolicyId}
DELETE /api/fleet/outputs/{outputId}
DELETE /api/fleet/fleet_server_hosts/{itemId}
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}
DELETE /api/fleet/enrollment_api_keys/{keyId}
DELETE /api/fleet/agents/{agentId}
DELETE /api/fleet/agents/files/{fileId}
DELETE /api/fleet/agent_download_sources/{sourceId}
DELETE /api/apm/sourcemaps/{id}
DELETE /api/apm/settings/agent-configuration
DELETE /api/alerting/rule/{id}
DELETE /api/actions/connector/{id}
GET /api/fleet/agents/action_status
GET /api/fleet/agents
GET /api/fleet/agent_status/data
GET /api/fleet/agent_status
GET /api/fleet/agent_policies/{agentPolicyId}/outputs
GET /api/fleet/agent_policies/{agentPolicyId}/full
GET /api/fleet/agent_policies/{agentPolicyId}/download
GET /api/fleet/agent_policies/{agentPolicyId}
GET /api/fleet/agent_policies
GET /api/fleet/agent_download_sources/{sourceId}
GET /api/fleet/agent_download_sources
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
GET /api/alerting/rules/_find
GET /api/alerting/rule/{id}
POST /api/fleet/service_tokens
POST /api/fleet/proxies
POST /api/fleet/package_policies/upgrade/dryrun
POST /api/fleet/package_policies/upgrade
POST /api/fleet/package_policies/delete
POST /api/fleet/package_policies/_bulk_get
POST /api/fleet/package_policies
POST /api/fleet/outputs
POST /api/fleet/message_signing_service/rotate_key_pair
POST /api/fleet/logstash_api_keys
POST /api/fleet/health_check
POST /api/fleet/fleet_server_hosts
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
POST /api/fleet/epm/packages/_bulk
POST /api/fleet/epm/packages
POST /api/fleet/epm/custom_integrations
POST /api/fleet/epm/bulk_assets
PUT /api/fleet/proxies/{itemId}
PUT /api/fleet/package_policies/{packagePolicyId}
PUT /api/fleet/outputs/{outputId}
PUT /api/fleet/fleet_server_hosts/{itemId}
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
PUT /api/fleet/agents/{agentId}
PUT /api/fleet/agent_policies/{agentPolicyId}
PUT /api/fleet/agent_download_sources/{sourceId}
PUT /api/apm/settings/agent-configuration
PUT /api/alerting/rule/{id}
PUT /api/actions/connector/{id}
POST /api/spaces/space
POST /api/spaces/_update_objects_spaces
POST /api/spaces/_get_shareable_references
POST /api/spaces/_disable_legacy_url_aliases
POST /api/spaces/_copy_saved_objects
POST /api/security/roles
POST /api/fleet/setup
POST /api/fleet/agent_policies
POST /api/fleet/agent_download_sources
POST /api/apm/sourcemaps
POST /api/apm/settings/agent-configuration/search
POST /api/apm/fleet/apm_server_schema
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
POST /api/alerting/rule/{id}/_update_api_key
POST /api/alerting/rule/{id}/_unmute_all
POST /api/alerting/rule/{id}/_mute_all
POST /api/alerting/rule/{id}/_enable
POST /api/alerting/rule/{id}/_disable
POST /api/alerting/rule/{id}
POST /api/actions/connector/{id}/_execute
POST /api/actions/connector/{id}
GET /api/status
GET /api/spaces/space/{id}
GET /api/spaces/space
POST /api/fleet/enrollment_api_keys
POST /api/fleet/agents/{agentId}/upgrade
POST /api/fleet/agents/{agentId}/unenroll
POST /api/fleet/agents/{agentId}/request_diagnostics
POST /api/fleet/agents/{agentId}/reassign
POST /api/fleet/agents/{agentId}/actions
POST /api/fleet/agents/setup
POST /api/fleet/agents/bulk_upgrade
POST /api/fleet/agents/bulk_update_agent_tags
POST /api/fleet/agents/bulk_unenroll
POST /api/fleet/agents/bulk_request_diagnostics
POST /api/fleet/agents/bulk_reassign
POST /api/fleet/agents/actions/{actionId}/cancel
POST /api/fleet/agents
POST /api/fleet/agent_policies/{agentPolicyId}/copy
POST /api/fleet/agent_policies/outputs
POST /api/fleet/agent_policies/delete
POST /api/fleet/agent_policies/_bulk_get
Kibana Serverless API
281 structure changes including:
143 Additions
6 Modifications
132 Removals
Modified 6
GET /api/apm/services/{serviceName}/annotation/search
  • Header
  • elastic-api-version header Added
  • Response
  • 400, 401, 500 responses Added
GET /api/entity_store/engines
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • engines property Modified
        • error property Added
GET /api/entity_store/engines/{entityType}
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • error property 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

  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • api_key, encoded, expiration, id, name properties Removed
      • agentKey property Added
  • 400, 401, 403, 500 responses Added
  • Header
  • elastic-api-version, kbn-xsrf headers 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

    • service property Modified

      • Property is now required

      • version property Modified

        • Property is now required

  • 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

  • 400, 401, 403, 404 responses Added
  • Header
  • elastic-api-version, kbn-xsrf headers Added
POST /api/entity_store/engines/{entityType}/init
  • Response
  • 200 response Modified
    • application/json; Elastic-Api-Version=2023-10-31 content type Modified
      • error property Added
Removed 132
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath*}
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
GET /api/fleet/epm/packages/{pkgName}/stats
GET /api/fleet/epm/packages/limited
GET /api/fleet/epm/packages/installed
GET /api/fleet/epm/packages
GET /api/fleet/epm/data_streams
GET /api/fleet/epm/categories
GET /api/fleet/enrollment_api_keys/{keyId}
GET /api/fleet/enrollment_api_keys
GET /api/fleet/data_streams
GET /api/fleet/check-permissions
GET /api/fleet/agents/{agentId}/uploads
GET /api/fleet/agents/{agentId}
GET /api/fleet/agents/tags
DELETE /api/actions/connector/{id}
GET /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs
GET /api/fleet/epm/verification_key_id
GET /api/fleet/fleet_server_hosts
GET /api/fleet/fleet_server_hosts/{itemId}
GET /api/fleet/kubernetes
GET /api/fleet/kubernetes/download
GET /api/fleet/outputs
GET /api/fleet/outputs/{outputId}
GET /api/fleet/outputs/{outputId}/health
GET /api/fleet/package_policies
GET /api/fleet/package_policies/{packagePolicyId}
GET /api/fleet/proxies
GET /api/fleet/proxies/{itemId}
GET /api/fleet/settings
GET /api/fleet/uninstall_tokens
GET /api/fleet/uninstall_tokens/{uninstallTokenId}
DELETE /api/alerting/rule/{id}
DELETE /api/fleet/agent_download_sources/{sourceId}
DELETE /api/fleet/agents/files/{fileId}
DELETE /api/fleet/agents/{agentId}
DELETE /api/fleet/enrollment_api_keys/{keyId}
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}
DELETE /api/fleet/fleet_server_hosts/{itemId}
DELETE /api/fleet/outputs/{outputId}
DELETE /api/fleet/package_policies/{packagePolicyId}
DELETE /api/fleet/proxies/{itemId}
DELETE /api/security/role/{name}
DELETE /api/spaces/space/{id}
GET /api/actions/connector/{id}
GET /api/actions/connector_types
GET /api/actions/connectors
GET /api/alerting/rule/{id}
GET /api/alerting/rules/_find
GET /api/fleet/agent_download_sources
GET /api/fleet/agent_download_sources/{sourceId}
GET /api/fleet/agent_policies
GET /api/fleet/agent_policies/{agentPolicyId}
GET /api/fleet/agent_policies/{agentPolicyId}/download
GET /api/fleet/agent_policies/{agentPolicyId}/full
GET /api/fleet/agent_policies/{agentPolicyId}/outputs
GET /api/fleet/agent_status
GET /api/fleet/agent_status/data
GET /api/fleet/agents
GET /api/fleet/agents/action_status
GET /api/fleet/agents/available_versions
GET /api/fleet/agents/files/{fileId}/{fileName}
GET /api/fleet/agents/setup
PUT /api/spaces/space/{id}
POST /api/fleet/package_policies/upgrade/dryrun
POST /api/fleet/package_policies/upgrade
POST /api/fleet/package_policies/delete
POST /api/fleet/package_policies/_bulk_get
POST /api/fleet/package_policies
POST /api/fleet/outputs
POST /api/fleet/message_signing_service/rotate_key_pair
POST /api/fleet/logstash_api_keys
POST /api/fleet/health_check
POST /api/fleet/fleet_server_hosts
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
POST /api/fleet/epm/packages/_bulk
POST /api/fleet/epm/packages
POST /api/fleet/epm/custom_integrations
POST /api/fleet/epm/bulk_assets
POST /api/fleet/enrollment_api_keys
PUT /api/security/role/{name}
PUT /api/fleet/settings
PUT /api/fleet/proxies/{itemId}
PUT /api/fleet/package_policies/{packagePolicyId}
PUT /api/fleet/outputs/{outputId}
PUT /api/fleet/fleet_server_hosts/{itemId}
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
PUT /api/fleet/agents/{agentId}
PUT /api/fleet/agent_policies/{agentPolicyId}
PUT /api/fleet/agent_download_sources/{sourceId}
PUT /api/alerting/rule/{id}
PUT /api/actions/connector/{id}
POST /api/spaces/space
POST /api/security/roles
POST /api/fleet/setup
POST /api/fleet/service_tokens
POST /api/fleet/proxies
POST /api/fleet/agent_policies
POST /api/fleet/agent_download_sources
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
POST /api/alerting/rule/{id}/_update_api_key
POST /api/alerting/rule/{id}/_unmute_all
POST /api/alerting/rule/{id}/_mute_all
POST /api/alerting/rule/{id}/_enable
POST /api/alerting/rule/{id}/_disable
POST /api/alerting/rule/{id}
POST /api/actions/connector/{id}/_execute
POST /api/actions/connector/{id}
GET /api/status
GET /api/spaces/space/{id}
GET /api/spaces/space
GET /api/security/role/{name}
GET /api/security/role
POST /api/fleet/agents/{agentId}/upgrade
POST /api/fleet/agents/{agentId}/unenroll
POST /api/fleet/agents/{agentId}/request_diagnostics
POST /api/fleet/agents/{agentId}/reassign
POST /api/fleet/agents/{agentId}/actions
POST /api/fleet/agents/setup
POST /api/fleet/agents/bulk_upgrade
POST /api/fleet/agents/bulk_update_agent_tags
POST /api/fleet/agents/bulk_unenroll
POST /api/fleet/agents/bulk_request_diagnostics
POST /api/fleet/agents/bulk_reassign
POST /api/fleet/agents/actions/{actionId}/cancel
POST /api/fleet/agents
POST /api/fleet/agent_policies/{agentPolicyId}/copy
POST /api/fleet/agent_policies/outputs
POST /api/fleet/agent_policies/delete
POST /api/fleet/agent_policies/_bulk_get
Added 143
PUT /api/spaces/space/{id}
PUT /api/security/role/{name}
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
GET /api/fleet/epm/packages/{pkgName}/stats
GET /api/fleet/epm/packages/limited
GET /api/fleet/epm/packages/installed
GET /api/fleet/epm/packages
GET /api/fleet/epm/data_streams
GET /api/fleet/epm/categories
GET /api/fleet/enrollment_api_keys/{keyId}
GET /api/fleet/enrollment_api_keys
GET /api/fleet/data_streams
GET /api/fleet/check-permissions
GET /api/fleet/agents/{agentId}/uploads
GET /api/fleet/agents/{agentId}
GET /api/fleet/agents/tags
GET /api/fleet/agents/setup
GET /api/fleet/agents/files/{fileId}/{fileName}
GET /api/fleet/agents/available_versions
GET /api/actions/connectors
POST /api/fleet/package_policies/upgrade
GET /api/fleet/uninstall_tokens/{uninstallTokenId}
GET /api/fleet/uninstall_tokens
GET /api/fleet/settings
GET /api/fleet/proxies/{itemId}
GET /api/fleet/proxies
GET /api/fleet/package_policies/{packagePolicyId}
GET /api/fleet/package_policies
GET /api/fleet/outputs/{outputId}/health
GET /api/fleet/outputs/{outputId}
GET /api/fleet/outputs
GET /api/fleet/kubernetes/download
GET /api/fleet/kubernetes
GET /api/fleet/fleet_server_hosts/{itemId}
GET /api/fleet/fleet_server_hosts
GET /api/fleet/epm/verification_key_id
GET /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath*}
GET /api/actions/connector_types
GET /api/actions/connector/{id}
DELETE /api/spaces/space/{id}
DELETE /api/security/role/{name}
DELETE /api/fleet/proxies/{itemId}
DELETE /api/fleet/package_policies/{packagePolicyId}
DELETE /api/fleet/outputs/{outputId}
DELETE /api/fleet/fleet_server_hosts/{itemId}
DELETE /api/fleet/epm/packages/{pkgName}/{pkgVersion}
DELETE /api/fleet/enrollment_api_keys/{keyId}
DELETE /api/fleet/agents/{agentId}
DELETE /api/fleet/agents/files/{fileId}
DELETE /api/fleet/agent_download_sources/{sourceId}
DELETE /api/apm/sourcemaps/{id}
DELETE /api/apm/settings/agent-configuration
DELETE /api/alerting/rule/{id}
DELETE /api/actions/connector/{id}
GET /api/fleet/agents/action_status
GET /api/fleet/agents
GET /api/fleet/agent_status/data
GET /api/fleet/agent_status
GET /api/fleet/agent_policies/{agentPolicyId}/outputs
GET /api/fleet/agent_policies/{agentPolicyId}/full
GET /api/fleet/agent_policies/{agentPolicyId}/download
GET /api/fleet/agent_policies/{agentPolicyId}
GET /api/fleet/agent_policies
GET /api/fleet/agent_download_sources/{sourceId}
GET /api/fleet/agent_download_sources
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
GET /api/alerting/rules/_find
GET /api/alerting/rule/{id}
POST /api/fleet/package_policies/delete
POST /api/fleet/package_policies/_bulk_get
POST /api/fleet/package_policies
POST /api/fleet/outputs
POST /api/fleet/message_signing_service/rotate_key_pair
POST /api/fleet/logstash_api_keys
POST /api/fleet/health_check
POST /api/fleet/fleet_server_hosts
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
POST /api/fleet/epm/packages/_bulk
POST /api/fleet/epm/packages
POST /api/fleet/epm/custom_integrations
POST /api/fleet/epm/bulk_assets
POST /api/fleet/enrollment_api_keys
POST /api/fleet/agents/{agentId}/upgrade
POST /api/apm/sourcemaps
PUT /api/fleet/settings
PUT /api/fleet/proxies/{itemId}
PUT /api/fleet/package_policies/{packagePolicyId}
PUT /api/fleet/outputs/{outputId}
PUT /api/fleet/fleet_server_hosts/{itemId}
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion}
PUT /api/fleet/agents/{agentId}
PUT /api/fleet/agent_policies/{agentPolicyId}
PUT /api/fleet/agent_download_sources/{sourceId}
PUT /api/apm/settings/agent-configuration
PUT /api/alerting/rule/{id}
PUT /api/actions/connector/{id}
POST /api/spaces/space
POST /api/security/roles
POST /api/fleet/setup
POST /api/fleet/service_tokens
POST /api/fleet/proxies
POST /api/fleet/package_policies/upgrade/dryrun
POST /api/apm/settings/agent-configuration/search
POST /api/apm/fleet/apm_server_schema
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
POST /api/alerting/rule/{id}/_update_api_key
POST /api/alerting/rule/{id}/_unmute_all
POST /api/alerting/rule/{id}/_mute_all
POST /api/alerting/rule/{id}/_enable
POST /api/alerting/rule/{id}/_disable
POST /api/alerting/rule/{id}
POST /api/actions/connector/{id}/_execute
POST /api/actions/connector/{id}
GET /api/status
GET /api/spaces/space/{id}
GET /api/spaces/space
GET /api/security/role/{name}
GET /api/security/role
POST /api/fleet/agents/{agentId}/unenroll
POST /api/fleet/agents/{agentId}/request_diagnostics
POST /api/fleet/agents/{agentId}/reassign
POST /api/fleet/agents/{agentId}/actions
POST /api/fleet/agents/setup
POST /api/fleet/agents/bulk_upgrade
POST /api/fleet/agents/bulk_update_agent_tags
POST /api/fleet/agents/bulk_unenroll
POST /api/fleet/agents/bulk_request_diagnostics
POST /api/fleet/agents/bulk_reassign
POST /api/fleet/agents/actions/{actionId}/cancel
POST /api/fleet/agents
POST /api/fleet/agent_policies/{agentPolicyId}/copy
POST /api/fleet/agent_policies/outputs
POST /api/fleet/agent_policies/delete
POST /api/fleet/agent_policies/_bulk_get
POST /api/fleet/agent_policies
POST /api/fleet/agent_download_sources
Elastic Cloud Serverless API
4 structure changes including:
4 Modifications
Modified 4
GET /api/v1/serverless/projects/observability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • endpoints property Modified
GET /api/v1/serverless/projects/observability/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • endpoints property Modified
        • ingest property Added
PATCH /api/v1/serverless/projects/observability/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • endpoints property Modified
        • ingest property Added
POST /api/v1/serverless/projects/observability
  • Response
  • 201 response Modified
    • application/json content type Modified
      • endpoints property Modified
        • ingest property Added
Elastic Cloud API

This documentation update aligns with the release summarized in https://www.elastic.co/guide/en/cloud/current/ec-release-notes-2024-10-31.html

6 structure changes including:
6 Modifications
Modified 6
GET /organizations
  • Response
  • 200 response Modified
    • content type Modified
      • organizations property Modified
        • sso_login_identifier property Added
GET /organizations/invitations/{invitation_token}
  • Response
  • 200 response Modified
    • content type Modified
      • organization property Modified
        • sso_login_identifier property Added
GET /organizations/{organization_id}
  • Response
  • 200 response Modified
    • content type Modified
      • sso_login_identifier property Added
GET /organizations/{organization_id}/invitations
  • Response
  • 200 response Modified
    • content type Modified
      • invitations property Modified
        • organization property Modified
POST /organizations/{organization_id}/invitations
  • Response
  • 201 response Modified
    • content type Modified
      • invitations property Modified
        • organization property Modified
PUT /organizations/{organization_id}
  • Response
  • 200 response Modified
    • content type Modified
      • sso_login_identifier property Added
Kibana API

This release removes the discontinued action APIs per https://github.com/elastic/kibana/pull/197510

17 structure changes including:
10 Modifications
7 Removals
Modified 10 Breaking
DELETE /api/security/role/{name}
  • Response
  • 204 response Added
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
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/note
  • Query
  • userFilter query parameter Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

  • createdByFilter query parameter Added
GET /api/security/role
  • Response
  • 200 response Added
GET /api/security/role/{name}
  • Response
  • 200 response 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
POST /api/security/roles
  • Response
  • 200 response Added
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
PUT /api/security/role/{name}
  • Response
  • 204 response Added
Removed 7
DELETE /api/actions/action/{id}
GET /api/actions
GET /api/actions/action/{id}
GET /api/actions/list_action_types
POST /api/actions/action
POST /api/actions/action/{id}/_execute
PUT /api/actions/action/{id}
Kibana Serverless API

This documentation update removes the discontinued action APIs, per https://github.com/elastic/kibana/pull/197510

17 structure changes including:
10 Modifications
7 Removals
Modified 10
DELETE /api/security/role/{name}
  • Response
  • 204 response Added
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
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/note
  • Query
  • userFilter query parameter Removed
  • createdByFilter query parameter Added
GET /api/security/role
  • Response
  • 200 response Added
GET /api/security/role/{name}
  • Response
  • 200 response 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
POST /api/security/roles
  • Response
  • 200 response Added
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
PUT /api/security/role/{name}
  • Response
  • 204 response Added
Removed 7
DELETE /api/actions/action/{id}
GET /api/actions
GET /api/actions/action/{id}
GET /api/actions/list_action_types
POST /api/actions/action
POST /api/actions/action/{id}/_execute
PUT /api/actions/action/{id}